pipx40_getDiagnostic

ViStatus pipx40_getDiagnostic (ViSession instrumentHandle, ViChar _VI_FAR diagnosticMessage[]);

Purpose

Obtains a card's diagnostic message, giving expanded information on any fault conditons indicated by "Get Card Status" - function pipx40_getCardStatus().

Parameters

Input
Name Type Description
instrumentHandle ViSession

Instrument handle obtained by the pipx40_init call used to open the card.

Output
Name Type Description
diagnosticMessage ViChar[]

Character string to receive the card's diagnostic message.
The message may contain embedded linefeed characters ('\x0A').
The maximum length of the message is defined by the driver constant pipx40_MAX_DIAG_LENGTH.
WARNING
Formatting and content of the diagnostic string may change as enhanced diagnostic features are made available. It should therefore not be interpreted programatically.

Return Value

Name Type Description
status ViStatus

A numeric code indicating the success or failure of the operation.
VI_SUCCESS = Successful operation.
Negative values are error codes and positive values are warnings.
To get a description of an error, pass the error code to pipx40_error_message.

References

ID & Status
Pickering Interfaces PXI VISA
Alphabetical Function Index
Hierarchical Function Index