IVsCommonMessagePump.SetTimeout(UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assemblies:: Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assemblies:: Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int SetTimeout(System::UInt32 dwTimeoutInMilliseconds);

public:
 int SetTimeout(unsigned int dwTimeoutInMilliseconds);

int SetTimeout(unsigned int dwTimeoutInMilliseconds);

public int SetTimeout (uint dwTimeoutInMilliseconds);

abstract member SetTimeout : uint32 -> int

Public Function SetTimeout (dwTimeoutInMilliseconds As UInteger) As Integer

Parameters

dwTimeoutInMilliseconds: UInt32

The maximum time in milliseconds.

Returns

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.

Applies to