pi40iv_SubInfo
ViStatus pi40iv_SubInfo (ViSession instrumentHandle, ViInt32 subUnit,
ViInt16 outNotIn, ViPInt32 type, ViPInt32 rows,
ViPInt32 columns);
Purpose
Get Pickering card sub-unit information (numeric format)
Parameters
| Input |
| Name |
Type |
Description |
| instrumentHandle |
ViSession |
The ViSession handle that you obtain from the pi40iv_init or pi40iv_InitWithOptions function. The handle identifies a particular instrument session.
Default Value: None
|
| subUnit |
ViInt32 |
sub-unit of target to access (unity-based)
|
| outNotIn |
ViInt16 |
1 for output subunit
0 for input subunit
|
| Output |
| Name |
Type |
Description |
| type |
ViInt32 (passed by reference) |
pointer to variable to receive type code result
|
| rows |
ViInt32 (passed by reference) |
pointer to variable to receive row dimension result
|
| columns |
ViInt32 (passed by reference) |
pointer to variable to receive column dimension result
|
Return Value
| Name |
Type |
Description |
| status |
ViStatus |
Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You examine the status code from each call to an instrument driver function to determine if an error occurred.
To obtain a text description of the status code, call the pi40iv_error_message function. To obtain additional information about the error condition, call the pi40iv_GetErrorInfo function. To clear the error information from the driver, call the pi40iv_ClearErrorInfo function.
The general meaning of the status code is as follows:
Value Meaning
-------------------------------
0 Success
Positive Values Warnings
Negative Values Errors
This driver defines the following status codes:
Status Description
-------------------------------------------------
WARNINGS:
/*=CHANGE:===================================================*
Insert Instrument-defined warning codes here.
*================================================END=CHANGE=*/
ERRORS:
/*=CHANGE:===================================================*
Insert Instrument-defined error codes here.
*================================================END=CHANGE=*/
This instrument driver also returns errors and warnings defined by other sources. The following table defines the ranges of additional status codes that this driver can return. The table lists the different include files that contain the defined constants for the particular status codes:
Numeric Range (in Hex) Status Code Types
-------------------------------------------------
3FFA2000 to 3FFA3FFF IviSwtch Warnings
3FFA0000 to 3FFA1FFF IVI Warnings
3FFF0000 to 3FFFFFFF VISA Warnings
3FFC0000 to 3FFCFFFF VXIPnP Driver Warnings
BFFA2000 to BFFA3FFF IviSwtch Errors
BFFA0000 to BFFA1FFF IVI Errors
BFFF0000 to BFFFFFFF VISA Errors
BFFC0000 to BFFCFFFF VXIPnP Driver Errors
|
References
Sub Information
Pickering
Pickering Interfaces PXI/LXI IVI Switch
Alphabetical Function Index
Hierarchical Function Index