Opal_Connect_By_Name

Connects to an active model specified at by Model Name and optionally by Model Path as well. This connection may get System Control if need be. On success a New Handle is returned as well as the current Model State and its Instance ID. This handle identifies the obtained connection and must be explicitly disconnected when all calls have been completed. This handle DOES NOT support concurrent RT-Lab API calls. If several simultaneous calls are necessary, other handles must first be acquired either with Opal_New_Connection_Handle, Opal_Open_Project or other connection functions.

Exact Match:

• Exact: A connection can only be established with an active model that shares both the Model Name and the Model Path.
• Similar: A connection can be established with any active model that shares the Model Name.

Return on Ambiguity:

• Return: If more than one active model satisfies the match criteria the error E2BIG (5007) is returned an no connection is established.
• Continue: If more than one active model satisfies the match criteria RT-Lab's "Active Models" window is displayed and the user may choose which model to connect to. If the operation is cancelled, the error OP_API_CMD_CANCELED (5699) is returned.

Deprecated

Please use Opal_Open_Project instead.

See also

Opal_Connect, Opal_Open_Project, Opal_Set_Current_Model