niSwitch_error_message
Specific Function
C Function Prototype
ViStatus niSwitch_error_message (ViSession vi, ViStatus errorCode, ViChar[] errorMessage);
Purpose
Converts an error code returned by NI-SWITCH into a user-readable string. Generally this information is supplied in error out of any NI-SWITCH VI. Use niSwitch_error_message for a static lookup of an error code description.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession | A particular NI-SWITCH session established with niSwitch_InitWithTopology, niSwitch_InitWithOptions, or niSwitch_init and used for all subsequent NI-SWITCH calls. |
| errorCode | ViStatus | Status code returned by any NI-SWITCH function. The default value is 0 (VI_SUCCESS). |
| errorMessage | ViChar[] | The error information formatted into a string. You must pass a ViChar array with at least 256 bytes. |