Share via

IHostThreadPoolManager::QueueUserWorkItem Method

  • Article

Queues a function for execution, and specifies an object containing data to be used by that function. The function executes when a thread becomes available.

HRESULT QueueUserWorkItem (
    [in] LPTHREAD_START_ROUTINE Function,
    [in] PVOID Context,
    [in] ULONG Flags
);

Parameters

  • Function
    [in] A function pointer that represents the function to execute.

  • Context
    [in] An object that contains data to be used by Function.

  • Flags
    [in] One of the flags values, as defined for the Win32 QueueUserWorkItem method, that control execution.

Return Value

HRESULT

Description

S_OK

QueueUserWorkItem returned successfully.

HOST_E_CLRNOTAVAILABLE

The common language runtime (CLR) has not been loaded into a process, or the CLR is in a state in which it cannot run managed code or process the call successfully.

HOST_E_TIMEOUT

The call timed out.

HOST_E_NOT_OWNER

The caller does not own the lock.

HOST_E_ABANDONED

An event was canceled while a blocked thread or fiber was waiting on it.

E_FAIL

An unknown catastrophic failure occurred. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.

Remarks

QueueUserWorkItem queues a work item to a worker thread in the thread pool. Its signature and parameter types are identical to those of the corresponding Win32 function, which has the same name. For more information, see the Windows Platform documentation.

Requirements

Platforms: Windows 2000, Windows XP, Windows Server 2003 family

Header: MSCorEE.idl

Library: Included as a resource in MSCorEE.dll

.NET Framework Version: 2.0

See Also

Concepts

IHostThreadPoolManager Interface

Reference

QueueUserWorkItem

ThreadPool