IVsCommonMessagePump::SetTimeout Method (UInt32)

Visual Studio 2015
 

Specifies the maximum time (in milliseconds) to wait for objects to signal.

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

C#
C++
F#
VB
Copy 
int SetTimeout(
	unsigned int dwTimeoutInMilliseconds
)

Parameters

dwTimeoutInMilliseconds
Type: System::UInt32

The maximum time in milliseconds.

Return Value

Type: System::Int32

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

The method returns if the interval elapses, even if the conditions specified by the fWaitForAllObjects parameter was not met. If dwMilliseconds is zero, the method tests the states of the specified objects and returns immediately. If the parameter is INFINITE (0xFFFFFFFF), the method's timeout interval never elapses.

Return to top
Show: