Method AddConnection

Namespace

Skyline.DataMiner.Scripting

Assembly

SLManagedScripting.dll

AddConnection(ConnectivityInterface, bool)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(ConnectivityInterface destItf, bool addBothCOnnections)

Parameters

destItf ConnectivityInterface

The destination interface.

addBothCOnnections bool

true if the connection entry should also be added to the destination connections table; otherwise, false.

Returns

bool

true if addition succeeded; otherwise, false.

AddConnection(string, int, bool)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string destElementKey, int destItf, bool addBothConnections)

Parameters

destElementKey string

The element key ("DataMiner Agent ID/element ID") of the element that owns the destination interface.

destItf int

The destination interface ID.

addBothConnections bool

true if the connection entry should also be added to the destination connections table; otherwise, false.

Returns

bool

true if the operation succeeded; otherwise, false.

AddConnection(ConnectivityInterface, string, bool)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(ConnectivityInterface destItf, string filter, bool addBothCOnnections)

Parameters

destItf ConnectivityInterface

The destination interface.

filter string

The connection filter.

addBothCOnnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

Returns

bool

true if the operation succeeded; otherwise, false.

AddConnection(string, string, ConnectivityInterface, bool)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string sourceName, string destName, ConnectivityInterface destItf, bool addBothConnections)

Parameters

sourceName string

The name to apply to this connection on the source.

destName string

The name to apply to this connection on the destination.

destItf ConnectivityInterface

The destination interface.

addBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

Returns

bool

true if the operation succeeded; otherwise, false.

AddConnection(ConnectivityInterface, bool, out int, out int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(ConnectivityInterface destItf, bool addBothCOnnections, out int sourcePK, out int destPK)

Parameters

destItf ConnectivityInterface

The destination interface.

addBothCOnnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourcePK int

The ID (primary key) of the connections table entry at the source.

destPK int

The ID (primary key) of the connections table entry at the destination.

Returns

bool

true if the operation succeeded; otherwise, false.

Remarks

Feature introduced in DataMiner 8.5.2 (RN 8438).

AddConnection(string, int, string, bool)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string destElementKey, int destItf, string filter, bool addBothConnections)

Parameters

destElementKey string

The element key ("DataMiner Agent ID/element ID") of the destination element.

destItf int

The destination interface.

filter string

The connection filter.

addBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

Returns

bool

true if the operation succeeded; otherwise, false.

AddConnection(string, string, ConnectivityInterface, string, bool)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string sourceName, string destName, ConnectivityInterface destItf, string filter, bool addBothConnections)

Parameters

sourceName string

The name to apply to this connection on the source.

destName string

The name to apply to this connection on the destination.

destItf ConnectivityInterface

The destination interface.

filter string

The connection filter.

addBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

Returns

bool

true if the operation succeeded; otherwise, false.

AddConnection(ConnectivityInterface, bool, out ConnectivityConnection, out ConnectivityConnection, int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(ConnectivityInterface destItf, bool addBothCOnnections, out ConnectivityConnection sourceConn, out ConnectivityConnection destConn, int timeoutMs)

Parameters

destItf ConnectivityInterface

The destination interface.

addBothCOnnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourceConn ConnectivityConnection

The connection added to the source.

destConn ConnectivityConnection

The connection added to the destination.

timeoutMs int

The connection addition timeout.

Returns

bool

true if the operation succeeded within the specified timeout; otherwise, false.

Remarks

In case the connection was not created within the specified timeout, false will be returned. However, the message will still be handled by DataMiner.

Feature introduced in DataMiner 8.5.2 (RN 8438).

AddConnection(ConnectivityInterface, string, bool, out int, out int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(ConnectivityInterface destItf, string filter, bool addBothCOnnections, out int sourcePK, out int destPK)

Parameters

destItf ConnectivityInterface

The destination interface.

filter string

The connection filter.

addBothCOnnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourcePK int

The ID (primary key) of the connection added to the source.

destPK int

The ID (primary key) of the connection added to the destination.

Returns

bool

true if the operation succeeded; otherwise, false.

Remarks

Feature introduced in DataMiner 8.5.2 (RN 8438).

AddConnection(string, int, bool, out int, out int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string destElementKey, int destItf, bool addBothConnections, out int sourcePK, out int destPK)

Parameters

destElementKey string

The element key ("DataMiner Agent ID/element ID") of the destination element.

destItf int

The ID of the destination interface.

addBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourcePK int

The ID (primary key) of the connection added to the source.

destPK int

The ID (primary key) of the connection added to the destination.

Returns

bool

true if the operation succeeded; otherwise, false.

AddConnection(string, string, string, int, bool)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string sourceName, string destName, string destElementKey, int destItf, bool addBothConnections)

Parameters

sourceName string

The name to apply to this connection on the source.

destName string

The name to apply to this connection on the destination.

destElementKey string

The element key ("DataMiner Agent ID/element ID") of the destination element.

destItf int

The ID of the destination interface.

addBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

Returns

bool

true if the operation succeeded; otherwise, false.

AddConnection(ConnectivityInterface, string, bool, out ConnectivityConnection, out ConnectivityConnection, int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(ConnectivityInterface destItf, string filter, bool addBothCOnnections, out ConnectivityConnection sourceConn, out ConnectivityConnection destConn, int timeoutMs)

Parameters

destItf ConnectivityInterface

The destination interface.

filter string

The connection filter.

addBothCOnnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourceConn ConnectivityConnection

The connection added to the source.

destConn ConnectivityConnection

The connection added to the destination.

timeoutMs int

The connection addition timeout.

Returns

bool

true if the operation succeeded within the specified timeout; otherwise, false.

Remarks

In case the connection was not created within the specified timeout, false will be returned. However, the message will still be handled by DataMiner.

Feature introduced in DataMiner 8.5.2 (RN 8438).

AddConnection(string, string, string, int, string, bool)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string sourceName, string destName, string destElementKey, int destItf, string filter, bool AddBothConnections)

Parameters

sourceName string

The name to apply to this connection on the source.

destName string

The name to apply to this connection on the destination.

destElementKey string

The element key ("DataMiner Agent ID/element ID") of the destination element.

destItf int

The ID of the destination interface.

filter string

The connection filter.

AddBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

Returns

bool

true if the operation succeeded; otherwise, false.

AddConnection(string, string, ConnectivityInterface, bool, out int, out int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string sourceName, string destName, ConnectivityInterface destItf, bool addBothConnections, out int sourcePK, out int destPK)

Parameters

sourceName string

The name to apply to this connection on the source.

destName string

The name to apply to this connection on the destination.

destItf ConnectivityInterface

The destination interface.

addBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourcePK int

The ID (primary key) of the connection added to the source.

destPK int

The ID (primary key) of the connection added to the destination.

Returns

bool

true if the operation succeeded; otherwise, false.

Remarks

Feature introduced in DataMiner 8.5.2 (RN 8438).

AddConnection(string, int, bool, out ConnectivityConnection, out ConnectivityConnection, int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string destElementKey, int destItf, bool addBothConnections, out ConnectivityConnection sourceConn, out ConnectivityConnection destConn, int timeoutMs)

Parameters

destElementKey string

The element key ("DataMiner Agent ID/element ID") of the destination element.

destItf int

The ID of the destination interface.

addBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourceConn ConnectivityConnection

The connection added to the source.

destConn ConnectivityConnection

The connection added to the destination.

timeoutMs int

The connection addition timeout.

Returns

bool

true if the operation succeeded within the specified timeout; otherwise, false.

Remarks

In case the connection was not created within the specified timeout, false will be returned. However, the message will still be handled by DataMiner.

AddConnection(string, int, string, bool, out int, out int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string destElementKey, int destItf, string filter, bool addBothConnections, out int sourcePK, out int destPK)

Parameters

destElementKey string

The element key ("DataMiner Agent ID/element ID") of the destination element.

destItf int

The ID of the destination interface.

filter string

The connection filter.

addBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourcePK int

The ID (primary key) of the connection added to the source.

destPK int

The ID (primary key) of the connection added to the destination.

Returns

bool

true if the operation succeeded; otherwise, false.

AddConnection(string, int, string, bool, out ConnectivityConnection, out ConnectivityConnection, int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string destElementKey, int destItf, string filter, bool addBothConnections, out ConnectivityConnection sourceConn, out ConnectivityConnection destConn, int timeoutMs)

Parameters

destElementKey string

The element key ("DataMiner Agent ID/element ID") of the destination element.

destItf int

The ID of the destination interface.

filter string

The connection filter.

addBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourceConn ConnectivityConnection

The connection added to the source.

destConn ConnectivityConnection

The connection added to the destination.

timeoutMs int

The connection addition timeout.

Returns

bool

true if the operation succeeded within the specified timeout; otherwise, false.

Remarks

In case the connection was not created within the specified timeout, false will be returned. However, the message will still be handled by DataMiner.

AddConnection(string, string, ConnectivityInterface, string, bool, out int, out int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string sourceName, string destName, ConnectivityInterface destItf, string filter, bool addBothConnections, out int sourcePK, out int destPK)

Parameters

sourceName string

The name to apply to this connection on the source.

destName string

The name to apply to this connection on the destination.

destItf ConnectivityInterface

The destination interface.

filter string

The connection filter.

addBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourcePK int

The ID (primary key) of the connections table entry at the source.

destPK int

The ID (primary key) of the connections table entry at the destination.

Returns

bool

true if the operation succeeded; otherwise, false.

Remarks

Feature introduced in DataMiner 8.5.2 (RN 8438).

AddConnection(string, string, ConnectivityInterface, bool, out ConnectivityConnection, out ConnectivityConnection, int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string sourceName, string destName, ConnectivityInterface destItf, bool AddBothConnections, out ConnectivityConnection sourceConn, out ConnectivityConnection destConn, int timeoutMs)

Parameters

sourceName string

The name to apply to this connection on the source.

destName string

The name to apply to this connection on the destination.

destItf ConnectivityInterface

The destination interface.

AddBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourceConn ConnectivityConnection

The connection added to the source.

destConn ConnectivityConnection

The connection added to the destination.

timeoutMs int

The connection addition timeout.

Returns

bool

true if the operation succeeded within the specified timeout; otherwise, false.

Remarks

In case the connection was not created within the specified timeout, false will be returned. However, the message will still be handled by DataMiner.

Feature introduced in DataMiner 8.5.2 (RN 8438).

AddConnection(string, string, string, int, bool, out int, out int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string sourceName, string destName, string destElementKey, int destItf, bool addBothConnections, out int sourcePK, out int destPK)

Parameters

sourceName string

The name to apply to this connection on the source.

destName string

The name to apply to this connection on the destination.

destElementKey string

The element key ("DataMiner Agent ID/element ID") of the destination element.

destItf int

The ID of the destination interface.

addBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourcePK int

The ID (primary key) of the connection added to the source.

destPK int

The ID (primary key) of the connection added to the destination.

Returns

bool

true if the operation succeeded; otherwise, false.

AddConnection(string, string, string, int, bool, out ConnectivityConnection, out ConnectivityConnection, int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string sourceName, string destName, string destElementKey, int destItf, bool addBothConnections, out ConnectivityConnection sourceConn, out ConnectivityConnection destConn, int timeoutMs)

Parameters

sourceName string

The name to apply to this connection on the source.

destName string

The name to apply to this connection on the destination.

destElementKey string

The element key ("DataMiner Agent ID/element ID") of the destination element.

destItf int

The ID of the destination interface.

addBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourceConn ConnectivityConnection

The connection added to the source.

destConn ConnectivityConnection

The connection added to the destination.

timeoutMs int

The connection addition timeout.

Returns

bool

true if the operation succeeded within the specified timeout; otherwise, false.

Remarks

In case the connection was not created within the specified timeout, false will be returned. However, the message will still be handled by DataMiner.

AddConnection(string, string, ConnectivityInterface, string, bool, out ConnectivityConnection, out ConnectivityConnection, int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string sourceName, string destName, ConnectivityInterface destItf, string filter, bool addBothConnections, out ConnectivityConnection sourceConn, out ConnectivityConnection destConn, int timeoutMs)

Parameters

sourceName string

The name to apply to this connection on the source.

destName string

The name to apply to this connection on the destination.

destItf ConnectivityInterface

The destination interface.

filter string

The connection filter.

addBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourceConn ConnectivityConnection

The connection added to the source.

destConn ConnectivityConnection

The connection added to the destination.

timeoutMs int

The connection addition timeout.

Returns

bool

true if the operation succeeded within the specified timeout; otherwise, false.

Remarks

In case the connection was not created within the specified timeout, false will be returned. However, the message will still be handled by DataMiner.

Feature introduced in DataMiner 8.5.2 (RN 8438).

AddConnection(string, string, string, int, string, bool, out int, out int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string sourceName, string destName, string destElementKey, int destItf, string filter, bool AddBothConnections, out int sourcePK, out int destPK)

Parameters

sourceName string

The name to apply to this connection on the source.

destName string

The name to apply to this connection on the destination.

destElementKey string

The element key ("DataMiner Agent ID/element ID") of the destination element.

destItf int

The ID of the destination interface.

filter string

The connection filter.

AddBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourcePK int

The ID (primary key) of the connection added to the source.

destPK int

The ID (primary key) of the connection added to the destination.

Returns

bool

true if the operation succeeded; otherwise, false.

AddConnection(string, string, string, int, string, bool, out ConnectivityConnection, out ConnectivityConnection, int)

Adds a connection between this interface and the specified destination interface.

public bool AddConnection(string sourceName, string destName, string destElementKey, int destItf, string filter, bool AddBothConnections, out ConnectivityConnection sourceConn, out ConnectivityConnection destConn, int timeoutMs)

Parameters

sourceName string

The name to apply to this connection on the source.

destName string

The name to apply to this connection on the destination.

destElementKey string

The element key ("DataMiner Agent ID/element ID") of the destination element.

destItf int

The ID of the destination interface.

filter string

The connection filter.

AddBothConnections bool

true if the connection entry should be added to both ends of the connection; otherwise, false.

sourceConn ConnectivityConnection

The connection added to the source.

destConn ConnectivityConnection

The connection added to the destination.

timeoutMs int

The connection addition timeout.

Returns

bool

true if the operation succeeded within the specified timeout; otherwise, false.

Remarks

In case the connection was not created within the specified timeout, false will be returned. However, the message will still be handled by DataMiner.