Reference

OpcClient.DeleteReference 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

Overload	Description
DeleteReference(OpcDeleteReference)since v2.7	Deletes a reference of existing nodes in the address space hierarchy using the command specified.
DeleteReference(OpcNodeId, OpcNodeId)	Deletes one or more references of existing nodes in the address space hierarchy using the identifiers of the nodes which shall not longer reference each other.
DeleteReference(OpcNodeId, OpcNodeId, OpcReferenceDirection?)	Deletes one or more references of existing nodes in the address space hierarchy using the identifiers of the nodes which shall not longer reference each other using the direction specified.
DeleteReference(OpcNodeId, OpcNodeId, OpcReferenceDirection?, OpcReferenceType)	Deletes one or more references of existing nodes in the address space hierarchy using the identifiers of the nodes which shall not longer reference each other using the direction specified.
DeleteReference(OpcNodeId, OpcNodeId, OpcReferenceDirection?, OpcNodeId)since v2.7	Deletes one or more references of existing nodes in the address space hierarchy using the identifiers of the nodes which shall not longer 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.

DeleteReference(OpcDeleteReference)

since v2.7

Deletes a reference of existing nodes in the address space hierarchy using the command specified.

public OpcStatus DeleteReference(OpcDeleteReference command)

Public Function DeleteReference(command As OpcDeleteReference) As OpcStatus

Parameters

Name	Type	Description
command	OpcDeleteReference	The OpcDeleteReference 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.
BadServerIndexInvalid	The server index is not valid.
BadTargetNodeIdInvalid	For more details see BadTargetNodeIdInvalid.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadNoDeleteRights	For more details see BadNoDeleteRights.

DeleteReference(OpcNodeId, OpcNodeId)

Deletes one or more references of existing nodes in the address space hierarchy using the identifiers of the nodes which shall not longer reference each other. The relation is deleted in bidirectional direction using Organizes as the type of reference.

public OpcStatus DeleteReference(OpcNodeId nodeId, OpcNodeId targetNodeId)

Public Function DeleteReference(
    nodeId As OpcNodeId,
    targetNodeId 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.

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).

Remarks

Known results for the service invocation are:

Status	Description
BadSourceNodeIdInvalid	For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid	For more details see BadReferenceTypeIdInvalid.
BadServerIndexInvalid	The server index is not valid.
BadTargetNodeIdInvalid	For more details see BadTargetNodeIdInvalid.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadNoDeleteRights	For more details see BadNoDeleteRights.

DeleteReference(OpcNodeId, OpcNodeId, OpcReferenceDirection?)

Deletes one or more references of existing nodes in the address space hierarchy using the identifiers of the nodes which shall not longer reference each other using the direction specified. The reference to delete have to be of the relation defined by direction using the Organizes as the type of reference.

public OpcStatus DeleteReference(
    OpcNodeId nodeId,
    OpcNodeId targetNodeId,
    OpcReferenceDirection? direction)

Public Function DeleteReference(
    nodeId As OpcNodeId,
    targetNodeId As OpcNodeId,
    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.
direction	Nullable<OpcReferenceDirection>	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation of reference to delete or a null reference (Nothing in Visual Basic) in case there the relation is to be deleted in bidirectional direction.

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).

Remarks

Known results for the service invocation are:

Status	Description
BadSourceNodeIdInvalid	For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid	For more details see BadReferenceTypeIdInvalid.
BadServerIndexInvalid	The server index is not valid.
BadTargetNodeIdInvalid	For more details see BadTargetNodeIdInvalid.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadNoDeleteRights	For more details see BadNoDeleteRights.

DeleteReference(OpcNodeId, OpcNodeId, OpcReferenceDirection?, OpcReferenceType)

Deletes one or more references of existing nodes in the address space hierarchy using the identifiers of the nodes which shall not longer reference each other using the direction specified. The reference to delete have to be of the relation defined by direction using the referenceType specified as the type of reference.

public OpcStatus DeleteReference(
    OpcNodeId nodeId,
    OpcNodeId targetNodeId,
    OpcReferenceDirection? direction,
    OpcReferenceType referenceType)

Public Function DeleteReference(
    nodeId As OpcNodeId,
    targetNodeId As OpcNodeId,
    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.
direction	Nullable<OpcReferenceDirection>	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation of reference to delete or a null reference (Nothing in Visual Basic) in case there the relation is to be deleted in bidirectional direction.
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).

Remarks

Known results for the service invocation are:

Status	Description
BadSourceNodeIdInvalid	For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid	For more details see BadReferenceTypeIdInvalid.
BadServerIndexInvalid	The server index is not valid.
BadTargetNodeIdInvalid	For more details see BadTargetNodeIdInvalid.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadNoDeleteRights	For more details see BadNoDeleteRights.

DeleteReference(OpcNodeId, OpcNodeId, OpcReferenceDirection?, OpcNodeId)

since v2.7

Deletes one or more references of existing nodes in the address space hierarchy using the identifiers of the nodes which shall not longer reference each other using the direction specified. The reference to delete have to be of the relation defined by direction using the type of reference identified by the referenceTypeId specified.

public OpcStatus DeleteReference(
    OpcNodeId nodeId,
    OpcNodeId targetNodeId,
    OpcReferenceDirection? direction,
    OpcNodeId referenceTypeId)

Public Function DeleteReference(
    nodeId As OpcNodeId,
    targetNodeId As OpcNodeId,
    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.
direction	Nullable<OpcReferenceDirection>	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation of reference to delete or a null reference (Nothing in Visual Basic) in case there the relation is to be deleted in bidirectional direction.
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).

Remarks

Known results for the service invocation are:

Status	Description
BadSourceNodeIdInvalid	For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid	For more details see BadReferenceTypeIdInvalid.
BadServerIndexInvalid	The server index is not valid.
BadTargetNodeIdInvalid	For more details see BadTargetNodeIdInvalid.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadNoDeleteRights	For more details see BadNoDeleteRights.