viStatusDesc
Purpose
Returns a user-readable description of the status code passed to the operation.
C Syntax
ViStatus viStatusDesc(ViObject vi, ViStatus status, ViChar desc[])
Visual Basic Syntax
viStatusDesc&(ByVal vi&, ByVal status&, ByVal desc$)
Resource Classes
All I/O session types, all event object types, VISA Resource Manager
Parameters
| Name | Direction | Description |
|---|---|---|
|
vi |
IN |
Unique logical identifier to a session. |
|
status |
IN |
Status code to interpret. |
|
desc |
OUT |
The user-readable string interpretation of the status code passed to the operation. |
Return Values
| Completion Codes | Description |
|---|---|
|
VI_SUCCESS |
Description successfully returned. |
|
VI_WARN_UNKNOWN_STATUS |
The status code passed to the operation could not be interpreted. |
Description
The viStatusDesc() operation is used to retrieve a user-readable string that describes the status code presented. If the string cannot be interpreted, the operation returns the warning code VI_WARN_UNKNOWN_STATUS. However, the output string desc is valid regardless of the status return value.
 |
Note The size of the desc parameter should be at least 256 bytes. |
Related Topics