Admin Production ni-theme
Current Publication

CmtGetThreadPoolAttribute

LabWindows/CVI

CmtGetThreadPoolAttribute

int CmtGetThreadPoolAttribute (CmtThreadPoolHandle poolHandle, int attributeID, void *attributeValue);

Purpose

Obtains the value of the thread pool attribute you specify.

Parameters

Input
Name Type Description
poolHandle CmtThreadPoolHandle Pass the handle you obtained from CmtNewThreadPool to identify the thread pool.

Pass DEFAULT_THREAD_POOL_HANDLE to specify the default thread pool.
attributeID int The ID of a thread pool attribute.
Output
Name Type Description
attributeValue void * The current value of the attribute.

The data type for this parameter depends on the data type of the attribute you specify for the attributeID parameter. Pass the address of a variable of the same data type of the attribute you pass to attributeID.

In the function panel, if the attribute currently showing in the Attribute ID ring control has named constants as valid values, you can view a list of values by pressing <Enter> on the control.

Return Value

Name Type Description
cmtStatus int The CmtStatus code that the function call returns. This function returns 0 to indicate success and negative values to indicate failure. Pass the CmtStatus code to CmtGetErrorMessage to get a description of the error code.

Additional Information

Library: Utility Library

Include file: utility.h

LabWindows/CVI compatibility: LabWindows/CVI 5.5 and later