viStatusDesc
Syntax
viStatusDesc(ViSession/ViEvent/ViFindList vi, ViStatus status, ViString desc);
Description
This function returns a user-readable string that describes the status code passed to the function. If a status code cannot be interpreted by the session, viStatusDesc returns the warning VI_WARN_UNKNOWN_STATUS.
Parameters
|
Name |
Dir |
Type |
Description |
|---|---|---|---|
|
vi |
IN |
ViSession |
Unique logical identifier to a session, event, or find list. |
|
status |
IN |
ViStatus |
Status code to interpret. |
|
desc |
OUT |
ViString |
The user-readable string interpretation of the status code passed to the function. Must be at least 256 characters to receive output. |
Return Values
|
Type ViStatus |
This is the function return status. It returns either a completion code or an error code as follows. |
|
Completion Code |
Description |
|---|---|
|
VI_SUCCESS |
Description successfully returned. |
|
VI_WARN_UNKNOWN_STATUS |
The status code passed to the function could not be interpreted. |