ApiSessionConnectPins Method |
Creates a connection between two pins.
This function will throw an exception if the connection cannot be created, e.g.
when the pins are on different hierarchy levels.
Namespace: Articy.Api
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
SyntaxC#
public ObjectProxy ConnectPins( ObjectProxy aOutPin, ObjectProxy aInPin )
Parameters
- aOutPin
- Type: Articy.ApiObjectProxy
Output pin to start the connection - aInPin
- Type: Articy.ApiObjectProxy
Input pin to end the connection
Return Value
Type: ObjectProxyThe newly created connection
Exceptions| Exception | Condition |
|---|---|
| ArticyApiException | ObjectNull when a parameter is null |
| ArticyApiException | WrongObjectType when a parameter is not a pin or the output/input constraints are not matched |
| ArticyApiException | InvalidParentForCreate when a connection is not possible (e.g. different hierarchy levels) |
See Also