CmtGetErrorMessage
- Updated2023-02-21
- 1 minute(s) read
CmtGetErrorMessage
int CmtGetErrorMessage (int cmtStatusCode, char cmtStatusMessage[]);
Purpose
Converts a CmtStatus error code into a meaningful message string.
If the error code is kCmtSystemError, this function gets the message string from the operating system for the specific error that occurred.
Parameters
| Input | ||||
| Name | Type | Description | ||
| cmtStatusCode | int | A CmtStatus code returned from a LabWindows/CVI Utility Library multithreading function. | ||
| Output | ||||
| Name | Type | Description | ||
| cmtStatusMessage | char [] | Returns a meaningful message string for a CmtStatus code.
|
||
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
Example
Refer to utility\threading\ThreadLocalVar\ThreadLocalVar.cws for an example of using the CmtGetErrorMessage function.