IVsThreadPool.ScheduleWaitableTask Method

Article
02/04/2013

Schedules a task and a handle to wait on before running the task.

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

Syntax

'Declaration
Function ScheduleWaitableTask ( _
    hWait As UInteger, _
    pTaskProc As UInteger, _
    pvParam As UInteger _
) As Integer

int ScheduleWaitableTask(
    uint hWait,
    uint pTaskProc,
    uint pvParam
)

int ScheduleWaitableTask(
    [InAttribute] unsigned int hWait, 
    [InAttribute] unsigned int pTaskProc, 
    [InAttribute] unsigned int pvParam
)

abstract ScheduleWaitableTask : 
        hWait:uint32 * 
        pTaskProc:uint32 * 
        pvParam:uint32 -> int

function ScheduleWaitableTask(
    hWait : uint, 
    pTaskProc : uint, 
    pvParam : uint
) : int

Parameters

hWait
Type: System.UInt32
[in] HANDLE to wait upon

pTaskProc
Type: System.UInt32
[in] The environment explicitly casts this pointer to a PVsBackgroundTask_Function_Pointer prior to being called.

pvParam
Type: System.UInt32
[in]

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:

HRESULT IVsThreadPool::ScheduleWaitableTask(
   [in] DWORD_PTR hWait, 
   [in] DWORD_PTR pTaskProc
);

.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.