ViStatus pi40iv_GetPath (ViSession instrumentHandle, ViChar _VI_FAR channel1[], ViChar _VI_FAR channel2[], ViInt32 bufferSize, ViChar _VI_FAR path[]);
In some cases there is more than one possible path between two channels. The driver or the instrument selects the path when you connect two channels with the pi40iv_Connect function. Thus, you cannot guarantee that every call to the pi40iv_Connect function establishes exactly the same path when you pass the same channels. This function returns a string that uniquely identifies the path you create with the pi40iv_Connect function. You can pass this string to the pi40iv_SetPath function to establish the exact same path in the future.
Note:
(1) This function returns only those paths that you explicitly
create by calling pi40iv_Connect and pi40iv_SetPath
functions. For example, if you connect channels CH1 and CH3,
and then channels CH2 and CH3, the explicit path between
channels CH1 and Ch2 does not exist and this function
returns an error.
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.
|
channel1 | ViChar[] |
You identify a path with two channels. Pass one of the channel names for which you want to obtain a path. Pass the other channel name as the Channel 2 parameter.
|
channel2 | ViChar[] |
You identify a path with two channels. Pass one of the channel names for which you want to obtain a path. Pass the other channel name as the Channel 1 parameter.
|
bufferSize | ViInt32 |
Pass the number of bytes in the ViChar array you specify for the Path List parameter.
|
Output | ||
Name | Type | Description |
path | ViChar[] |
The comma-separated path between channels you specify in the Channel 1 and Channel 2 parameters. |
Name | Type | Description |
statusOrRequiredSize | 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.
|
Paths
Route
Pickering Interfaces PXI/LXI IVI Switch
Alphabetical Function Index
Hierarchical Function Index