Reference

OpcClient.AddReference Method

Type

OpcClient

Namespace

Opc.UaFx.Client

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Members

OpcClient Members

Also in

Opc.UaFx.Client

5 overloads · since v2.7

Overload	Description
AddReference(OpcAddReference)since v2.7	Adds a new reference to existing nodes in the address space hierarchy using the command specified.
AddReference(OpcNodeId, OpcNodeId, OpcNodeCategory)since v2.7	Adds a new reference to existing nodes in the address space hierarchy using the identifiers of the nodes which shall reference each other.
AddReference(OpcNodeId, OpcNodeId, OpcNodeCategory, OpcReferenceDirection)since v2.7	Adds a new reference to existing nodes in the address space hierarchy using the identifiers of the nodes which shall reference each other using the direction specified.
AddReference(OpcNodeId, OpcNodeId, OpcNodeCategory, OpcReferenceDirection, OpcReferenceType)since v2.7	Adds a new reference to existing nodes in the address space hierarchy using the identifiers of the nodes which shall reference each other using the direction specified.
AddReference(OpcNodeId, OpcNodeId, OpcNodeCategory, OpcReferenceDirection, OpcNodeId)since v2.7	Adds a new reference to existing nodes in the address space hierarchy using the identifiers of the nodes which shall reference each other using the direction specified.

Exceptions (all overloads)

Exception	Condition
ObjectDisposedException	The object has been disposed of.
OpcException	The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.

AddReference(OpcAddReference)

since v2.7

Adds a new reference to existing nodes in the address space hierarchy using the command specified.

public OpcStatus AddReference(OpcAddReference command)

Public Function AddReference(command As OpcAddReference) As OpcStatus

Parameters

Name	Type	Description
command	OpcAddReference	The OpcAddReference instance to process.

Returns

OpcStatus

An instance of the OpcStatus class which contains the information about the outcome of the processed command.

Exceptions

Exception	Condition
ArgumentNullException	The command is a null reference (Nothing in Visual Basic).
InvalidOperationException	The add node service is currently not supported, especially using the command specified.

Remarks

Known results for the command specified are:

Status	Description
BadSourceNodeIdInvalid	For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid	For more details see BadReferenceTypeIdInvalid.
BadServerUriInvalid	For more details see BadServerUriInvalid.
BadTargetNodeIdInvalid	For more details see BadTargetNodeIdInvalid.
BadNodeClassInvalid	For more details see BadNodeClassInvalid.
BadReferenceNotAllowed	The reference could not be created because it violates constraints imposed by the data model on this server.
BadReferenceLocalOnly	The reference type is not valid for a reference to a remote server.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadDuplicateReferenceNotAllowed	The reference type between the nodes is already defined.
BadInvalidSelfReference	The server does not allow this type of self reference on this node.

AddReference(OpcNodeId, OpcNodeId, OpcNodeCategory)

since v2.7

Adds a new reference to existing nodes in the address space hierarchy using the identifiers of the nodes which shall reference each other. The new reference will be a ParentToChild relation using Organizes as the type of reference.

public OpcStatus AddReference(
    OpcNodeId nodeId,
    OpcNodeId targetNodeId,
    OpcNodeCategory targetNodeCategory)

Public Function AddReference(
    nodeId As OpcNodeId,
    targetNodeId As OpcNodeId,
    targetNodeCategory As OpcNodeCategory) As OpcStatus

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId through that the source node can be identified and accessed. This identifier refers to the 'child' node.
targetNodeId	OpcNodeId	The OpcNodeId through that the target node can be identified and accessed. This identifier referes to the 'parent' node.
targetNodeCategory	OpcNodeCategory	One of the members defined by the OpcNodeCategory enumeration which is used by the server to validate that the reference to be added matches the OpcNodeCategory of the target node identified by the targetNodeId.

Returns

OpcStatus

Exceptions

Exception	Condition
ArgumentException	The nodeId or targetNodeId is equals Null.
ArgumentNullException	The nodeId or targetNodeId is a null reference (Nothing in Visual Basic).
InvalidOperationException	The add node service is currently not supported, especially using the parameters specified.

Remarks

Known results for the service invocation are:

Status	Description
BadSourceNodeIdInvalid	For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid	For more details see BadReferenceTypeIdInvalid.
BadServerUriInvalid	For more details see BadServerUriInvalid.
BadTargetNodeIdInvalid	For more details see BadTargetNodeIdInvalid.
BadNodeClassInvalid	For more details see BadNodeClassInvalid.
BadReferenceNotAllowed	The reference could not be created because it violates constraints imposed by the data model on this server.
BadReferenceLocalOnly	The reference type is not valid for a reference to a remote server.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadDuplicateReferenceNotAllowed	The reference type between the nodes is already defined.
BadInvalidSelfReference	The server does not allow this type of self reference on this node.

AddReference(OpcNodeId, OpcNodeId, OpcNodeCategory, OpcReferenceDirection)

since v2.7

Adds a new reference to existing nodes in the address space hierarchy using the identifiers of the nodes which shall reference each other using the direction specified. The new reference will use the relation defined by direction using the Organizes as the type of reference.

public OpcStatus AddReference(
    OpcNodeId nodeId,
    OpcNodeId targetNodeId,
    OpcNodeCategory targetNodeCategory,
    OpcReferenceDirection direction)

Public Function AddReference(
    nodeId As OpcNodeId,
    targetNodeId As OpcNodeId,
    targetNodeCategory As OpcNodeCategory,
    direction As OpcReferenceDirection) As OpcStatus

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId through that the source node can be identified and accessed.
targetNodeId	OpcNodeId	The OpcNodeId through that the target node can be identified and accessed.
targetNodeCategory	OpcNodeCategory	One of the members defined by the OpcNodeCategory enumeration which is used by the server to validate that the reference to be added matches the OpcNodeCategory of the target node identified by the targetNodeId.
direction	OpcReferenceDirection	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation the reference will construct.

Returns

OpcStatus

Exceptions

Exception	Condition
ArgumentException	The nodeId or targetNodeId is equals Null.
ArgumentNullException	The nodeId or targetNodeId is a null reference (Nothing in Visual Basic).
InvalidOperationException	The add node service is currently not supported, especially using the parameters specified.

Remarks

Known results for the service invocation are:

Status	Description
BadSourceNodeIdInvalid	For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid	For more details see BadReferenceTypeIdInvalid.
BadServerUriInvalid	For more details see BadServerUriInvalid.
BadTargetNodeIdInvalid	For more details see BadTargetNodeIdInvalid.
BadNodeClassInvalid	For more details see BadNodeClassInvalid.
BadReferenceNotAllowed	The reference could not be created because it violates constraints imposed by the data model on this server.
BadReferenceLocalOnly	The reference type is not valid for a reference to a remote server.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadDuplicateReferenceNotAllowed	The reference type between the nodes is already defined.
BadInvalidSelfReference	The server does not allow this type of self reference on this node.

AddReference(OpcNodeId, OpcNodeId, OpcNodeCategory, OpcReferenceDirection, OpcReferenceType)

since v2.7

Adds a new reference to existing nodes in the address space hierarchy using the identifiers of the nodes which shall reference each other using the direction specified. The new reference will use the relation defined by direction using the referenceType specified as the type of reference.

public OpcStatus AddReference(
    OpcNodeId nodeId,
    OpcNodeId targetNodeId,
    OpcNodeCategory targetNodeCategory,
    OpcReferenceDirection direction,
    OpcReferenceType referenceType)

Public Function AddReference(
    nodeId As OpcNodeId,
    targetNodeId As OpcNodeId,
    targetNodeCategory As OpcNodeCategory,
    direction As OpcReferenceDirection,
    referenceType As OpcReferenceType) As OpcStatus

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId through that the source node can be identified and accessed.
targetNodeId	OpcNodeId	The OpcNodeId through that the target node can be identified and accessed.
targetNodeCategory	OpcNodeCategory	One of the members defined by the OpcNodeCategory enumeration which is used by the server to validate that the reference to be added matches the OpcNodeCategory of the target node identified by the targetNodeId.
direction	OpcReferenceDirection	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation the reference will construct.
referenceType	OpcReferenceType	One of the members defined by the OpcReferenceType enumeration to use to setup the reference between the source and the target node identified by the nodeId and the targetNodeId.

Returns

OpcStatus

Exceptions

Exception	Condition
ArgumentException	The nodeId or targetNodeId is equals Null.
ArgumentNullException	The nodeId or targetNodeId is a null reference (Nothing in Visual Basic).
InvalidOperationException	The add node service is currently not supported, especially using the parameters specified.

Remarks

Known results for the service invocation are:

Status	Description
BadSourceNodeIdInvalid	For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid	For more details see BadReferenceTypeIdInvalid.
BadServerUriInvalid	For more details see BadServerUriInvalid.
BadTargetNodeIdInvalid	For more details see BadTargetNodeIdInvalid.
BadNodeClassInvalid	For more details see BadNodeClassInvalid.
BadReferenceNotAllowed	The reference could not be created because it violates constraints imposed by the data model on this server.
BadReferenceLocalOnly	The reference type is not valid for a reference to a remote server.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadDuplicateReferenceNotAllowed	The reference type between the nodes is already defined.
BadInvalidSelfReference	The server does not allow this type of self reference on this node.

AddReference(OpcNodeId, OpcNodeId, OpcNodeCategory, OpcReferenceDirection, OpcNodeId)

since v2.7

Adds a new reference to existing nodes in the address space hierarchy using the identifiers of the nodes which shall reference each other using the direction specified. The new reference will use the relation defined by direction using the type of reference identified by the referenceTypeId specified.

public OpcStatus AddReference(
    OpcNodeId nodeId,
    OpcNodeId targetNodeId,
    OpcNodeCategory targetNodeCategory,
    OpcReferenceDirection direction,
    OpcNodeId referenceTypeId)

Public Function AddReference(
    nodeId As OpcNodeId,
    targetNodeId As OpcNodeId,
    targetNodeCategory As OpcNodeCategory,
    direction As OpcReferenceDirection,
    referenceTypeId As OpcNodeId) As OpcStatus

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId through that the source node can be identified and accessed.
targetNodeId	OpcNodeId	The OpcNodeId through that the target node can be identified and accessed.
targetNodeCategory	OpcNodeCategory	One of the members defined by the OpcNodeCategory enumeration which is used by the server to validate that the reference to be added matches the OpcNodeCategory of the target node identified by the targetNodeId.
direction	OpcReferenceDirection	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation the reference will construct.
referenceTypeId	OpcNodeId	The OpcNodeId which identifies the type of reference to use to setup the reference between the source and the target node identified by the nodeId and the targetNodeId.

Returns

OpcStatus

Exceptions

Exception	Condition
ArgumentException	The nodeId, targetNodeId or referenceTypeId is equals Null.
ArgumentNullException	The nodeId, targetNodeId or referenceTypeId is a null reference (Nothing in Visual Basic).
InvalidOperationException	The add node service is currently not supported, especially using the parameters specified.

Remarks

Known results for the service invocation are:

Status	Description
BadSourceNodeIdInvalid	For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid	For more details see BadReferenceTypeIdInvalid.
BadServerUriInvalid	For more details see BadServerUriInvalid.
BadTargetNodeIdInvalid	For more details see BadTargetNodeIdInvalid.
BadNodeClassInvalid	For more details see BadNodeClassInvalid.
BadReferenceNotAllowed	The reference could not be created because it violates constraints imposed by the data model on this server.
BadReferenceLocalOnly	The reference type is not valid for a reference to a remote server.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadDuplicateReferenceNotAllowed	The reference type between the nodes is already defined.
BadInvalidSelfReference	The server does not allow this type of self reference on this node.