Reference

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

12 overloads · since v2.18

Overload	Description
TranslatePath(params OpcName[])since v2.18	Translates a path starting from the root node using the pathElements specified.
TranslatePath(IEnumerable<OpcName>)since v2.18	Translates a path starting from the root node using the pathElements specified.
TranslatePath(OpcNodeId, params OpcName[])since v2.18	Translates a path starting from the node identified by the nodeId specified using the pathElements passed.
TranslatePath(OpcNodeId, IEnumerable<OpcName>)since v2.18	Translates a path starting from the node identified by the nodeId specified using the pathElements passed.
TranslatePath(params OpcRelativePathElement[])since v2.18	Translates a path starting from the root node using the pathElements specified.
TranslatePath(IEnumerable<OpcRelativePathElement>)since v2.18	Translates a path starting from the root node using the pathElements specified.
TranslatePath(OpcNodeId, params OpcRelativePathElement[])since v2.18	Translates a path starting from the node identified by the nodeId specified using the pathElements passed.
TranslatePath(OpcNodeId, IEnumerable<OpcRelativePathElement>)since v2.18	Translates a path starting from the node identified by the nodeId specified using the pathElements passed.
TranslatePath(string)since v2.18	Translates the path starting from the root node.
TranslatePath(OpcNodeId, string)since v2.18	Translates the path starting from the node identified by the nodeId specified.
TranslatePath(OpcNodeId, OpcRelativePath)since v2.18	Translates the path starting from the node identified by the nodeId specified.
TranslatePath(OpcTranslatePath)since v2.18	Translates a path starting from a dedicated node using the command 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.

TranslatePath(params OpcName[])

since v2.18

Translates a path starting from the root node using the pathElements specified.

public OpcNodeId TranslatePath(params OpcName[] pathElements)

Public Function TranslatePath(ParamArray pathElements As OpcName()) As OpcNodeId

Parameters

Name	Type	Description
pathElements	params OpcName[]	An array of OpcName objects representing the value of the BrowseName attribute of the nodes to visit to translate the last OpcName item in pathElements to the OpcNodeId requested by the service.

Returns

OpcNodeId

The target identifier the pathElements were translated to or a null reference (Nothing in Visual Basic) if the path could not translated.

Exceptions

Exception	Condition
ArgumentNullException	The pathElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationException	The translate path service is currently not supported, especially using the pathElements specified.

Remarks

Known results for this method are:

Status	Description
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadNothingToDo	This code indicates that the relativePath contained an empty list.
BadBrowseNameInvalid	This code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServer	The path element has targets which are in another server.
BadTooManyMatches	The requested operation has too many matches to return. Users should use queries for large result sets. Servers should allow at least 10 matches before returning this error code.
BadQueryTooComplex	The requested operation requires too many resources in the server.
BadNoMatch	The requested relativePath cannot be resolved to a target to return.

TranslatePath(IEnumerable<OpcName>)

since v2.18

Translates a path starting from the root node using the pathElements specified.

public OpcNodeId TranslatePath(IEnumerable<OpcName> pathElements)

Public Function TranslatePath(
    pathElements As IEnumerable(Of OpcName)) As OpcNodeId

Parameters

Name	Type	Description
pathElements	IEnumerable<OpcName>	A sequence of OpcName objects representing the value of the BrowseName attribute of the nodes to visit to translate the last OpcName item in pathElements to the OpcNodeId requested by the service.

Returns

OpcNodeId

The target identifier the pathElements were translated to or a null reference (Nothing in Visual Basic) if the path could not translated.

Exceptions

Exception	Condition
ArgumentNullException	The pathElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationException	The translate path service is currently not supported, especially using the pathElements specified.

Remarks

Known results for this method are:

Status	Description
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadNothingToDo	This code indicates that the relativePath contained an empty list.
BadBrowseNameInvalid	This code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServer	The path element has targets which are in another server.
BadTooManyMatches	The requested operation has too many matches to return. Users should use queries for large result sets. Servers should allow at least 10 matches before returning this error code.
BadQueryTooComplex	The requested operation requires too many resources in the server.
BadNoMatch	The requested relativePath cannot be resolved to a target to return.

TranslatePath(OpcNodeId, params OpcName[])

since v2.18

Translates a path starting from the node identified by the nodeId specified using the pathElements passed.

public OpcNodeId TranslatePath(OpcNodeId nodeId, params OpcName[] pathElements)

Public Function TranslatePath(
    nodeId As OpcNodeId,
    ParamArray pathElements As OpcName()) As OpcNodeId

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node on which the service will translate the pathElements.
pathElements	params OpcName[]	An array of OpcName objects representing the value of the BrowseName attribute of the nodes to visit to translate the last OpcName item in pathElements to the OpcNodeId requested by the service.

Returns

OpcNodeId

The target identifier the pathElements were translated to or a null reference (Nothing in Visual Basic) if the path could not translated.

Exceptions

Exception	Condition
ArgumentNullException	The pathElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationException	The translate path service is currently not supported, especially using the pathElements specified.

Remarks

Known results for this method are:

Status	Description
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadNothingToDo	This code indicates that the relativePath contained an empty list.
BadBrowseNameInvalid	This code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServer	The path element has targets which are in another server.
BadTooManyMatches	The requested operation has too many matches to return. Users should use queries for large result sets. Servers should allow at least 10 matches before returning this error code.
BadQueryTooComplex	The requested operation requires too many resources in the server.
BadNoMatch	The requested relativePath cannot be resolved to a target to return.

TranslatePath(OpcNodeId, IEnumerable<OpcName>)

since v2.18

Translates a path starting from the node identified by the nodeId specified using the pathElements passed.

public OpcNodeId TranslatePath(
    OpcNodeId nodeId,
    IEnumerable<OpcName> pathElements)

Public Function TranslatePath(
    nodeId As OpcNodeId,
    pathElements As IEnumerable(Of OpcName)) As OpcNodeId

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node on which the service will translate the pathElements.
pathElements	IEnumerable<OpcName>	A sequence of OpcName objects representing the value of the BrowseName attribute of the nodes to visit to translate the last OpcName item in pathElements to the OpcNodeId requested by the service.

Returns

OpcNodeId

The target identifier the pathElements were translated to or a null reference (Nothing in Visual Basic) if the path could not translated.

Exceptions

Exception	Condition
ArgumentNullException	The pathElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationException	The translate path service is currently not supported, especially using the pathElements specified.

Remarks

Known results for this method are:

Status	Description
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadNothingToDo	This code indicates that the relativePath contained an empty list.
BadBrowseNameInvalid	This code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServer	The path element has targets which are in another server.
BadTooManyMatches	The requested operation has too many matches to return. Users should use queries for large result sets. Servers should allow at least 10 matches before returning this error code.
BadQueryTooComplex	The requested operation requires too many resources in the server.
BadNoMatch	The requested relativePath cannot be resolved to a target to return.

TranslatePath(params OpcRelativePathElement[])

since v2.18

Translates a path starting from the root node using the pathElements specified.

public OpcNodeId TranslatePath(params OpcRelativePathElement[] pathElements)

Public Function TranslatePath(
    ParamArray pathElements As OpcRelativePathElement()) As OpcNodeId

Parameters

Name	Type	Description
pathElements	params OpcRelativePathElement[]	An array of OpcRelativePathElement objects representing the translation directives of the nodes to visit to translate the last OpcRelativePathElement item in pathElements to the OpcNodeId requested by the service.

Returns

OpcNodeId

The target identifier the pathElements were translated to or a null reference (Nothing in Visual Basic) if the path could not translated.

Exceptions

Exception	Condition
ArgumentNullException	The pathElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationException	The translate path service is currently not supported, especially using the pathElements specified.

Remarks

Known results for this method are:

Status	Description
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadNothingToDo	This code indicates that the relativePath contained an empty list.
BadBrowseNameInvalid	This code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServer	The path element has targets which are in another server.
BadTooManyMatches	The requested operation has too many matches to return. Users should use queries for large result sets. Servers should allow at least 10 matches before returning this error code.
BadQueryTooComplex	The requested operation requires too many resources in the server.
BadNoMatch	The requested relativePath cannot be resolved to a target to return.

TranslatePath(IEnumerable<OpcRelativePathElement>)

since v2.18

Translates a path starting from the root node using the pathElements specified.

public OpcNodeId TranslatePath(IEnumerable<OpcRelativePathElement> pathElements)

Public Function TranslatePath(
    pathElements As IEnumerable(Of OpcRelativePathElement)) As OpcNodeId

Parameters

Name	Type	Description
pathElements	IEnumerable<OpcRelativePathElement>	A sequence of OpcRelativePathElement objects representing the translation directives of the nodes to visit to translate the last OpcRelativePathElement item in pathElements to the OpcNodeId requested by the service.

Returns

OpcNodeId

The target identifier the pathElements were translated to or a null reference (Nothing in Visual Basic) if the path could not translated.

Exceptions

Exception	Condition
ArgumentNullException	The pathElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationException	The translate path service is currently not supported, especially using the pathElements specified.

Remarks

Known results for this method are:

Status	Description
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadNothingToDo	This code indicates that the relativePath contained an empty list.
BadBrowseNameInvalid	This code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServer	The path element has targets which are in another server.
BadTooManyMatches	The requested operation has too many matches to return. Users should use queries for large result sets. Servers should allow at least 10 matches before returning this error code.
BadQueryTooComplex	The requested operation requires too many resources in the server.
BadNoMatch	The requested relativePath cannot be resolved to a target to return.

TranslatePath(OpcNodeId, params OpcRelativePathElement[])

since v2.18

Translates a path starting from the node identified by the nodeId specified using the pathElements passed.

public OpcNodeId TranslatePath(
    OpcNodeId nodeId,
    params OpcRelativePathElement[] pathElements)

Public Function TranslatePath(
    nodeId As OpcNodeId,
    ParamArray pathElements As OpcRelativePathElement()) As OpcNodeId

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node on which the service will translate the pathElements.
pathElements	params OpcRelativePathElement[]	An array of OpcRelativePathElement objects representing the translation directives of the nodes to visit to translate the last OpcRelativePathElement item in pathElements to the OpcNodeId requested by the service.

Returns

OpcNodeId

The target identifier the pathElements were translated to or a null reference (Nothing in Visual Basic) if the path could not translated.

Exceptions

Exception	Condition
ArgumentNullException	The pathElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationException	The translate path service is currently not supported, especially using the pathElements specified.

Remarks

Known results for this method are:

Status	Description
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadNothingToDo	This code indicates that the relativePath contained an empty list.
BadBrowseNameInvalid	This code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServer	The path element has targets which are in another server.
BadTooManyMatches	The requested operation has too many matches to return. Users should use queries for large result sets. Servers should allow at least 10 matches before returning this error code.
BadQueryTooComplex	The requested operation requires too many resources in the server.
BadNoMatch	The requested relativePath cannot be resolved to a target to return.

TranslatePath(OpcNodeId, IEnumerable<OpcRelativePathElement>)

since v2.18

Translates a path starting from the node identified by the nodeId specified using the pathElements passed.

public OpcNodeId TranslatePath(
    OpcNodeId nodeId,
    IEnumerable<OpcRelativePathElement> pathElements)

Public Function TranslatePath(
    nodeId As OpcNodeId,
    pathElements As IEnumerable(Of OpcRelativePathElement)) As OpcNodeId

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node on which the service will translate the pathElements.
pathElements	IEnumerable<OpcRelativePathElement>	A sequence of OpcRelativePathElement objects representing the translation directives of the nodes to visit to translate the last OpcRelativePathElement item in pathElements to the OpcNodeId requested by the service.

Returns

OpcNodeId

The target identifier the pathElements were translated to or a null reference (Nothing in Visual Basic) if the path could not translated.

Exceptions

Exception	Condition
ArgumentNullException	The pathElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationException	The translate path service is currently not supported, especially using the pathElements specified.

Remarks

Known results for this method are:

Status	Description
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadNothingToDo	This code indicates that the relativePath contained an empty list.
BadBrowseNameInvalid	This code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServer	The path element has targets which are in another server.
BadTooManyMatches	The requested operation has too many matches to return. Users should use queries for large result sets. Servers should allow at least 10 matches before returning this error code.
BadQueryTooComplex	The requested operation requires too many resources in the server.
BadNoMatch	The requested relativePath cannot be resolved to a target to return.

TranslatePath(string)

since v2.18

Translates the path starting from the root node.

public OpcNodeId TranslatePath(string path)

Public Function TranslatePath(path As String) As OpcNodeId

Parameters

Name	Type	Description
path	String	A string representing a OpcRelativePath to the OpcNodeId requested by the service.

Returns

OpcNodeId

The target identifier the path was translated to or a null reference (Nothing in Visual Basic) if the path could not translated.

Exceptions

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

Remarks

Known results for this method are:

Status	Description
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadNothingToDo	This code indicates that the relativePath contained an empty list.
BadBrowseNameInvalid	This code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServer	The path element has targets which are in another server.
BadTooManyMatches	The requested operation has too many matches to return. Users should use queries for large result sets. Servers should allow at least 10 matches before returning this error code.
BadQueryTooComplex	The requested operation requires too many resources in the server.
BadNoMatch	The requested relativePath cannot be resolved to a target to return.

TranslatePath(OpcNodeId, string)

since v2.18

Translates the path starting from the node identified by the nodeId specified.

public OpcNodeId TranslatePath(OpcNodeId nodeId, string path)

Public Function TranslatePath(nodeId As OpcNodeId, path As String) As OpcNodeId

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node on which the service will translate the path.
path	String	A string representing a OpcRelativePath to the OpcNodeId requested by the service.

Returns

OpcNodeId

The target identifier the path was translated to or a null reference (Nothing in Visual Basic) if the path could not translated.

Exceptions

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

Remarks

Known results for this method are:

Status	Description
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadNothingToDo	This code indicates that the relativePath contained an empty list.
BadBrowseNameInvalid	This code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServer	The path element has targets which are in another server.
BadTooManyMatches	The requested operation has too many matches to return. Users should use queries for large result sets. Servers should allow at least 10 matches before returning this error code.
BadQueryTooComplex	The requested operation requires too many resources in the server.
BadNoMatch	The requested relativePath cannot be resolved to a target to return.

TranslatePath(OpcNodeId, OpcRelativePath)

since v2.18

Translates the path starting from the node identified by the nodeId specified.

public OpcNodeId TranslatePath(OpcNodeId nodeId, OpcRelativePath path)

Public Function TranslatePath(
    nodeId As OpcNodeId,
    path As OpcRelativePath) As OpcNodeId

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node on which the service will translate the path.
path	OpcRelativePath	The OpcRelativePath to the OpcNodeId requested by the service.

Returns

OpcNodeId

The target identifier the path was translated to or a null reference (Nothing in Visual Basic) if the path could not translated.

Exceptions

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

Remarks

Known results for this method are:

Status	Description
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadNothingToDo	This code indicates that the relativePath contained an empty list.
BadBrowseNameInvalid	This code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServer	The path element has targets which are in another server.
BadTooManyMatches	The requested operation has too many matches to return. Users should use queries for large result sets. Servers should allow at least 10 matches before returning this error code.
BadQueryTooComplex	The requested operation requires too many resources in the server.
BadNoMatch	The requested relativePath cannot be resolved to a target to return.

TranslatePath(OpcTranslatePath)

since v2.18

Translates a path starting from a dedicated node using the command specified.

public OpcTranslatePathResult TranslatePath(OpcTranslatePath command)

Public Function TranslatePath(
    command As OpcTranslatePath) As OpcTranslatePathResult

Parameters

Name	Type	Description
command	OpcTranslatePath	The OpcTranslatePath instance to process.

Returns

OpcTranslatePathResult

An instance of the OpcTranslatePathResult class which contains the target identifier the path has been translated to through the command specified; together with information about the outcome of the processed command.

Exceptions

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

Remarks

Known results for the command specified are:

Status	Description
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadNothingToDo	This code indicates that the relativePath contained an empty list.
BadBrowseNameInvalid	This code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServer	The path element has targets which are in another server.
BadTooManyMatches	The requested operation has too many matches to return. Users should use queries for large result sets. Servers should allow at least 10 matches before returning this error code.
BadQueryTooComplex	The requested operation requires too many resources in the server.
BadNoMatch	The requested relativePath cannot be resolved to a target to return.