IVsThreadedWaitDialog::GiveTimeSlice Method (String^, String^, Int32, Int32)

Visual Studio 2015

Allows updating the text in the dialog, and checks if the user has cancelled the wait.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

C++

int GiveTimeSlice(
	String^ bstrUpdatedWaitMessage,
	String^ bstrIfTruncateAppend,
	int fDisableCancel,
	[OutAttribute] int% pfCancelled
)

Parameters

bstrUpdatedWaitMessage: Type: System::String^
[in] The updated wait message. Can be null.

bstrIfTruncateAppend: Type: System::String^
[in] Can be null, should be a short string e.g. L"..." or L"...\""

fDisableCancel: Type: System::Int32
[in] Disable the button if the operation can no longer be cancelled.

pfCancelled: Type: System::Int32
[out] Returns true if the operation was cancelled.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

C++

HRESULT IVsThreadedWaitDialog::GiveTimeSlice(
   [in] BSTR bstrUpdatedWaitMessage, 
   [in] BSTR bstrIfTruncateAppend, 
   [in] BOOL fDisableCancel, 
   [out] BOOL *pfCancelled
);