IviSwtch_CanConnect

CVI/LabWindows IVI Class Driver

IviSwtch_CanConnect

IviSwtchBase Capability Group

C Function Prototype

ViStatus IviSwtch_CanConnect (ViSession vi, ViConstString channel1, ViConstString channel2, ViInt32 *pathCapability);

Purpose

This function verifies that the switch module is capable of creating a path between the two channels you specify with the channel1 and channel2 parameters. If the switch module is capable of creating a path, this function returns the current availability given the existing connections in the pathCapability parameter.

If the path is not available due to currently existing connections, but the implicit connection between the two channels already exists, the function returns the warning IVISWTCH_WARN_IMPLICIT_CONNECTION_EXISTS.

Parameters

Inputs Type Description
vi ViSession The instrument handle that you obtain from the IviSwtch_init or IviSwtch_InitWithOptions functions. The handle identifies a particular IVI session.
channel1 ViConstString You identify a path with two channels. Pass one of the virtual channel names for which you want to verify a path. Pass the other channel name as the channel2 parameter.

Virtual channel names are aliases for instrument specific channel strings. The instrument specific channel strings can differ from one instrument to another. Virtual channel names allow you to use and swap instruments without having to change the channel names in your source code. You assign a virtual channel name to an instrument specific channel through MAX. This control accepts virtual channel names you have assigned to the specific instrument you are using. It also accepts the instrument specific channel names.

Note  You can specify the channel name as a string variable or as a literal enclosed in double quotes.
channel2 ViConstString You identify a path with two channels. Pass one of the virtual channel names for which you want to verify a path. Pass the other channel name as the channel1 parameter.

Virtual channel names are aliases for instrument specific channel strings. The instrument specific channel strings can differ from one instrument to another. Virtual channel names allow you to use and swap instruments without having to change the channel names in your source code. You assign a virtual channel name to an instrument specific channel through MAX. This control accepts virtual channel names you have assigned to the specific instrument you are using. It also accepts the instrument specific channel names.

Note  You can specify the channel name as a string variable or as a literal enclosed in double quotes.
     
Outputs Type Description
path Capability ViInt32
(passed by
reference)
Indicates whether a path is valid.

Defined Values

Return Values