pi40iv_Connect

ViStatus pi40iv_Connect (ViSession instrumentHandle, ViChar _VI_FAR channel1[], ViChar _VI_FAR channel2[]);

Purpose

This function creates a path between Channel 1 and Channel 2.  The driver calculates the shortest path between the two channels.
/*=CHANGE:====================================================*/
Add comments here about possible connections for your instrument.
/*==================================================END=CHANGE*/
If a path is not available, the function returns one of the following errors:
PI40IV_ERROR_EXPLICIT_CONNECTION_EXISTS (0xBFFA200C), if the two channels
are already explicitly connected by calling
either the pi40iv_Connect or
pi40iv_SetPath function.
PI40IV_ERROR_IS_CONFIGURATION_CHANNEL (0xBFFA2009), if a channel is a
configuration channel.  Error elaboration
contains information about which of the two
channels is a configuration channel.
PI40IV_ERROR_ATTEMPT_TO_CONNECT_SOURCES (0xBFFA200B), if both channels are
connected to a different source.  Error
elaboration contains information about sources
channel 1 and 2 connect to.
PI40IV_ERROR_CANNOT_CONNECT_TO_ITSELF (0xBFFA2015), if channels 1 and 2 are
one and the same channel.
PI40IV_ERROR_PATH_NOT_FOUND (0xBFFA2011), if the driver cannot find a path
between the two channels.
Notes:
(1) The paths are bidirectional. For example, if a path exists
between channels CH1 and CH2, then the path between channels
CH2 and CH1 also exists.

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
channel1	ViChar[]	You identify a path with two channels. Pass one of the channel names for which you want to create a path. Pass the other channel name as the Channel 2 parameter. Valid Channel Names: x1,x2,y1,y2 Default Value: ""
channel2	ViChar[]	You identify a path with two channels. Pass one of the channel names for which you want to create a path. Pass the other channel name as the Channel 1 parameter. Valid Channel Names: x1,x2,y1,y2 Default Value: ""

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

Route
Pickering Interfaces PXI/LXI IVI Switch
Alphabetical Function Index
Hierarchical Function Index