pipx40_getDiagnostic
|
Function |
pipx40_getDiagnostic (ByVal vi As Long, ByVal message As String) As Long | |
|
ViStatus |
pipx40_getDiagnostic (ViSession vi, ViString message); |
|
Parameter |
I/O |
Description |
|
vi |
in |
Instrument handle |
|
message |
out |
Instrument diagnostic string |
Return Value
0 = Successful operation. Negative values are error codes and positive values are warnings. To get a description of the error, pass the error code to pipx40_error_message.
Description
Obtains the diagnostic string of the specified card, giving expanded information on any fault conditions indicated by the pipx40_getCardStatus value or pipx40_self_test result.
Remarks
The result string may include embedded newline characters, coded as ASCII linefeed (0Ah).
The length of the result string will not exceed the value of 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.
Visual Basic Notes
The result is a C-style string, terminated by an ASCII null character. It can be converted to a Visual Basic string by counting the number of characters upto but excluding the terminating null, then performing:
VBstring = LEFT$(message, character_count).
If the diagnostic string is to be displayed in Visual Basic, any embedded linefeed characters (0Ah) should be expanded to vbCrLf.