IVsCommonMessagePump.SetTimeout Method
Specifies the maximum time (in milliseconds) to wait for objects to signal.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assemblies: Microsoft.VisualStudio.Shell.Interop.10.0 (in Microsoft.VisualStudio.Shell.Interop.10.0.dll)
Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
Syntax
'Declaration
Function SetTimeout ( _
dwTimeoutInMilliseconds As UInteger _
) As Integer
int SetTimeout(
uint dwTimeoutInMilliseconds
)
int SetTimeout(
[InAttribute] unsigned int dwTimeoutInMilliseconds
)
abstract SetTimeout :
dwTimeoutInMilliseconds:uint32 -> int
function SetTimeout(
dwTimeoutInMilliseconds : uint
) : int
Parameters
dwTimeoutInMilliseconds
Type: UInt32The maximum time in milliseconds.
Return Value
Type: Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.
Remarks
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.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.