Skip to content

Reference

OpcClient.DeleteNode Method

Deletes a node from the address space hierarchy using the command specified.

Reference

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

3 overloads

OverloadDescription
DeleteNode(OpcDeleteNode)since v2.7Deletes a node from the address space hierarchy using the command specified.
DeleteNode(OpcNodeId)Deletes a node from the address space hierarchy using the identifier of the node which shall be deleted including the references where the node acts as the source and as the target of the reference.
DeleteNode(OpcNodeId, bool)Deletes a node from the address space hierarchy using the identifier of the node which shall be deleted including the references where the node acts as the source and optionally (see includeTargetReferences) as the target of the reference.

Exceptions (all overloads)

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

DeleteNode(OpcDeleteNode) ​

since v2.7

Deletes a node from the address space hierarchy using the command specified.

csharp
public OpcStatus DeleteNode(OpcDeleteNode command)
vbnet
Public Function DeleteNode(command As OpcDeleteNode) As OpcStatus

Parameters

NameTypeDescription
commandOpcDeleteNodeThe OpcDeleteNode instance to process.

Returns

OpcStatus

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

Exceptions

ExceptionCondition
ArgumentNullExceptionThe command is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe add node service is currently not supported, especially using the command specified.

Remarks

Known results for the command specified are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadUserAccessDeniedFor more details see BadUserAccessDenied.
BadNoDeleteRightsFor more details see BadNoDeleteRights.
UncertainReferenceNotDeletedThe server was not able to delete all target references.

DeleteNode(OpcNodeId) ​

Deletes a node from the address space hierarchy using the identifier of the node which shall be deleted including the references where the node acts as the source and as the target of the reference.

csharp
public OpcStatus DeleteNode(OpcNodeId nodeId)
vbnet
Public Function DeleteNode(nodeId As OpcNodeId) As OpcStatus

Parameters

NameTypeDescription
nodeIdOpcNodeIdThe OpcNodeId through that the node to delete can be identified and accessed.

Returns

OpcStatus

Exceptions

ExceptionCondition
ArgumentExceptionThe nodeId is equals Null.
ArgumentNullExceptionThe nodeId is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe delete node service is currently not supported, especially using the parameters specified.

Remarks

Known results for the service invocation are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadUserAccessDeniedFor more details see BadUserAccessDenied.
BadNoDeleteRightsFor more details see BadNoDeleteRights.
UncertainReferenceNotDeletedThe server was not able to delete all target references.

DeleteNode(OpcNodeId, bool) ​

Deletes a node from the address space hierarchy using the identifier of the node which shall be deleted including the references where the node acts as the source and optionally (see includeTargetReferences) as the target of the reference.

csharp
public OpcStatus DeleteNode(OpcNodeId nodeId, bool includeTargetReferences)
vbnet
Public Function DeleteNode(
    nodeId As OpcNodeId,
    includeTargetReferences As Boolean) As OpcStatus

Parameters

NameTypeDescription
nodeIdOpcNodeIdThe OpcNodeId through that the node to delete can be identified and accessed.
includeTargetReferencesBooleanA value indicating whether all references there the node being deleted acts as the target shall be deleted as well. The value true if all references using the node to delete as the target of the reference shall be deleted as well; otherwise the value false which indicates that only references there the node to delete acts as the source of the reference.

Returns

OpcStatus

Exceptions

ExceptionCondition
ArgumentExceptionThe nodeId is equals Null.
ArgumentNullExceptionThe nodeId is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe delete node service is currently not supported, especially using the parameters specified.

Remarks

Known results for the service invocation are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadUserAccessDeniedFor more details see BadUserAccessDenied.
BadNoDeleteRightsFor more details see BadNoDeleteRights.
UncertainReferenceNotDeletedThe server was not able to delete all target references.