ClusWorkerCheckTerminate function (resapi.h)

Article
02/22/2024

Determines whether a worker thread should exit as soon as possible. The PCLUSAPIClusWorkerCheckTerminate type defines a pointer to this function.

Syntax

BOOL ClusWorkerCheckTerminate(
  [in] PCLUS_WORKER lpWorker
);

Parameters

[in] lpWorker

Pointer to a CLUS_WORKER structure describing the thread to check.

Return value

ClusWorkerCheckTerminate returns one of the following values.

Return code/value	Description
TRUE 1	The thread should terminate.
FALSE 0	The thread should not terminate.

Remarks

The ClusWorkerCheckTerminate utility function checks the Terminate member of the CLUS_WORKER structure to determine whether the thread pointed to by Worker should exit. The Terminate member is used to prevent problems from occurring when multiple threads call ClusWorkerTerminate on the same worker thread.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Target Platform	Windows
Header	resapi.h
Library	ResUtils.lib
DLL	ResUtils.dll