Skip to content

Reference

OpcClient.TranslatePaths Method

Translates paths starting from the root node using the pathsElements specified.

Reference

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

16 overloads · since v2.18

OverloadDescription
TranslatePaths(params IEnumerable<OpcName>[])since v2.18Translates paths starting from the root node using the pathsElements specified.
TranslatePaths(IEnumerable<IEnumerable<OpcName>>)since v2.18Translates paths starting from the root node using the pathsElements specified.
TranslatePaths(OpcNodeId, params IEnumerable<OpcName>[])since v2.18Translates paths starting from the node identified by the nodeId specified using the pathsElements passed.
TranslatePaths(OpcNodeId, IEnumerable<IEnumerable<OpcName>>)since v2.18Translates paths starting from the node identified by the nodeId specified using the pathsElements passed.
TranslatePaths(params IEnumerable<OpcRelativePathElement>[])since v2.18Translates a path starting from the root node using the pathsElements specified.
TranslatePaths(IEnumerable<IEnumerable<OpcRelativePathElement>>)since v2.18Translates paths starting from the root node using the pathsElements specified.
TranslatePaths(OpcNodeId, params IEnumerable<OpcRelativePathElement>[])since v2.18Translates paths starting from the node identified by the nodeId specified using the pathsElements passed.
TranslatePaths(OpcNodeId, IEnumerable<IEnumerable<OpcRelativePathElement>>)since v2.18Translates paths starting from the node identified by the nodeId specified using the pathsElements passed.
TranslatePaths(params string[])since v2.18Translates the paths starting from the root node.
TranslatePaths(IEnumerable<string>)since v2.18Translates the paths starting from the root node.
TranslatePaths(OpcNodeId, params string[])since v2.18Translates the paths starting from the node identified by the nodeId specified.
TranslatePaths(OpcNodeId, IEnumerable<string>)since v2.18Translates the paths starting from the node identified by the nodeId specified.
TranslatePaths(OpcNodeId, params OpcRelativePath[])since v2.18Translates the paths starting from the node identified by the nodeId specified.
TranslatePaths(OpcNodeId, IEnumerable<OpcRelativePath>)since v2.18Translates the paths starting from the node identified by the nodeId specified.
TranslatePaths(IEnumerable<OpcTranslatePath>)since v2.18Translates one or more paths starting from one or more dedicated nodes using the specified commands.
TranslatePaths(params OpcTranslatePath[])since v2.18Translates one or more paths starting from one or more dedicated nodes using the specified commands.

Exceptions (all overloads)

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

TranslatePaths(params IEnumerable<OpcName>[]) ​

since v2.18

Translates paths starting from the root node using the pathsElements specified.

csharp
public IEnumerable<OpcNodeId> TranslatePaths(
    params IEnumerable<OpcName>[] pathsElements)
vbnet
Public Function TranslatePaths(
    ParamArray pathsElements As IEnumerable(Of OpcName)()) As IEnumerable(Of OpcNodeId)

Parameters

NameTypeDescription
pathsElementsparams IEnumerable<OpcName>[]An array of sequences of OpcName objects representing the value of the BrowseName attribute of the nodes to visit to translate the last OpcName item in a sequence in pathsElements to the OpcNodeIds requested by the service.

Returns

IEnumerable<OpcNodeId>

The target identifiers the pathsElements could translated to.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe pathsElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the pathsElements specified.
ObjectDisposedExceptionThe object has been disposed of.

Remarks

Known results for this method are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(IEnumerable<IEnumerable<OpcName>>) ​

since v2.18

Translates paths starting from the root node using the pathsElements specified.

csharp
public IEnumerable<OpcNodeId> TranslatePaths(
    IEnumerable<IEnumerable<OpcName>> pathsElements)
vbnet
Public Function TranslatePaths(
    pathsElements As IEnumerable(Of IEnumerable(Of OpcName))) As IEnumerable(Of OpcNodeId)

Parameters

NameTypeDescription
pathsElementsIEnumerable<IEnumerable<OpcName>>A sequence of sequences of OpcName objects representing the value of the BrowseName attribute of the nodes to visit to translate the last OpcName item in a sequence in pathsElements to the OpcNodeIds requested by the service.

Returns

IEnumerable<OpcNodeId>

The target identifiers the pathsElements could translated to.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe pathsElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the pathsElements specified.
ObjectDisposedExceptionThe object has been disposed of.

Remarks

Known results for this method are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(OpcNodeId, params IEnumerable<OpcName>[]) ​

since v2.18

Translates paths starting from the node identified by the nodeId specified using the pathsElements passed.

csharp
public IEnumerable<OpcNodeId> TranslatePaths(
    OpcNodeId nodeId,
    params IEnumerable<OpcName>[] pathsElements)
vbnet
Public Function TranslatePaths(
    nodeId As OpcNodeId,
    ParamArray pathsElements As IEnumerable(Of OpcName)()) As IEnumerable(Of OpcNodeId)

Parameters

NameTypeDescription
nodeIdOpcNodeIdThe OpcNodeId of the node on which the service will translate the pathsElements.
pathsElementsparams IEnumerable<OpcName>[]An array of sequences of OpcName objects representing the value of the BrowseName attribute of the nodes to visit to translate the last OpcName item in a sequence in pathsElements to the OpcNodeIds requested by the service.

Returns

IEnumerable<OpcNodeId>

The target identifiers the pathsElements could translated to.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe pathsElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the pathsElements specified.
ObjectDisposedExceptionThe object has been disposed of.

Remarks

Known results for this method are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(OpcNodeId, IEnumerable<IEnumerable<OpcName>>) ​

since v2.18

Translates paths starting from the node identified by the nodeId specified using the pathsElements passed.

csharp
public IEnumerable<OpcNodeId> TranslatePaths(
    OpcNodeId nodeId,
    IEnumerable<IEnumerable<OpcName>> pathsElements)
vbnet
Public Function TranslatePaths(
    nodeId As OpcNodeId,
    pathsElements As IEnumerable(Of IEnumerable(Of OpcName))) As IEnumerable(Of OpcNodeId)

Parameters

NameTypeDescription
nodeIdOpcNodeIdThe OpcNodeId of the node on which the service will translate the pathsElements.
pathsElementsIEnumerable<IEnumerable<OpcName>>A sequence of sequences of OpcName objects representing the value of the BrowseName attribute of the nodes to visit to translate the last OpcName item in a sequence in pathsElements to the OpcNodeIds requested by the service.

Returns

IEnumerable<OpcNodeId>

The target identifiers the pathsElements could translated to.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe pathsElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the pathsElements specified.
ObjectDisposedExceptionThe object has been disposed of.

Remarks

Known results for this method are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(params IEnumerable<OpcRelativePathElement>[]) ​

since v2.18

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

csharp
public IEnumerable<OpcNodeId> TranslatePaths(
    params IEnumerable<OpcRelativePathElement>[] pathsElements)
vbnet
Public Function TranslatePaths(
    ParamArray pathsElements As IEnumerable(Of OpcRelativePathElement)()) As IEnumerable(Of OpcNodeId)

Parameters

NameTypeDescription
pathsElementsparams IEnumerable<OpcRelativePathElement>[]An array of sequences of OpcRelativePathElement objects representing the translation directives of the nodes to visit to translate the last OpcRelativePathElement item a sequence in pathsElements to the OpcNodeIds requested by the service.

Returns

IEnumerable<OpcNodeId>

The target identifiers the pathsElements could translated to.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe pathsElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the pathsElements specified.
ObjectDisposedExceptionThe object has been disposed of.

Remarks

Known results for this method are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(IEnumerable<IEnumerable<OpcRelativePathElement>>) ​

since v2.18

Translates paths starting from the root node using the pathsElements specified.

csharp
public IEnumerable<OpcNodeId> TranslatePaths(
    IEnumerable<IEnumerable<OpcRelativePathElement>> pathsElements)
vbnet
Public Function TranslatePaths(
    pathsElements As IEnumerable(Of IEnumerable(Of OpcRelativePathElement))) As IEnumerable(Of OpcNodeId)

Parameters

NameTypeDescription
pathsElementsIEnumerable<IEnumerable<OpcRelativePathElement>>A sequence of sequences of OpcRelativePathElement objects representing the translation directives of the nodes to visit to translate the last OpcRelativePathElement item in a sequence in pathsElements to the OpcNodeIds requested by the service.

Returns

IEnumerable<OpcNodeId>

The target identifiers the pathsElements could translated to.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe pathsElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the pathsElements specified.
ObjectDisposedExceptionThe object has been disposed of.

Remarks

Known results for this method are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(OpcNodeId, params IEnumerable<OpcRelativePathElement>[]) ​

since v2.18

Translates paths starting from the node identified by the nodeId specified using the pathsElements passed.

csharp
public IEnumerable<OpcNodeId> TranslatePaths(
    OpcNodeId nodeId,
    params IEnumerable<OpcRelativePathElement>[] pathsElements)
vbnet
Public Function TranslatePaths(
    nodeId As OpcNodeId,
    ParamArray pathsElements As IEnumerable(Of OpcRelativePathElement)()) As IEnumerable(Of OpcNodeId)

Parameters

NameTypeDescription
nodeIdOpcNodeIdThe OpcNodeId of the node on which the service will translate the pathsElements.
pathsElementsparams IEnumerable<OpcRelativePathElement>[]An array of sequences of OpcRelativePathElement objects representing the translation directives of the nodes to visit to translate the last OpcRelativePathElement item in a sequence of pathsElements to the OpcNodeIds requested by the service.

Returns

IEnumerable<OpcNodeId>

The target identifiers the pathsElements could translated to.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe pathsElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the pathsElements specified.
ObjectDisposedExceptionThe object has been disposed of.

Remarks

Known results for this method are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(OpcNodeId, IEnumerable<IEnumerable<OpcRelativePathElement>>) ​

since v2.18

Translates paths starting from the node identified by the nodeId specified using the pathsElements passed.

csharp
public IEnumerable<OpcNodeId> TranslatePaths(
    OpcNodeId nodeId,
    IEnumerable<IEnumerable<OpcRelativePathElement>> pathsElements)
vbnet
Public Function TranslatePaths(
    nodeId As OpcNodeId,
    pathsElements As IEnumerable(Of IEnumerable(Of OpcRelativePathElement))) As IEnumerable(Of OpcNodeId)

Parameters

NameTypeDescription
nodeIdOpcNodeIdThe OpcNodeId of the node on which the service will translate the pathsElements.
pathsElementsIEnumerable<IEnumerable<OpcRelativePathElement>>A sequence of sequences of OpcRelativePathElement objects representing the translation directives of the nodes to visit to translate the last OpcRelativePathElement item in a sequence of pathsElements to the OpcNodeIds requested by the service.

Returns

IEnumerable<OpcNodeId>

The target identifiers the pathsElements could translated to.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe pathsElements or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the pathsElements specified.
ObjectDisposedExceptionThe object has been disposed of.

Remarks

Known results for this method are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(params string[]) ​

since v2.18

Translates the paths starting from the root node.

csharp
public IEnumerable<OpcNodeId> TranslatePaths(params string[] paths)
vbnet
Public Function TranslatePaths(
    ParamArray paths As String()) As IEnumerable(Of OpcNodeId)

Parameters

NameTypeDescription
pathsparams String[]An array of string instances representing a OpcRelativePath to the OpcNodeIds requested by the service.

Returns

IEnumerable<OpcNodeId>

The target identifiers the paths could translated to.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe paths or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the paths specified.
ObjectDisposedExceptionThe object has been disposed of.

Remarks

Known results for this method are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(IEnumerable<string>) ​

since v2.18

Translates the paths starting from the root node.

csharp
public IEnumerable<OpcNodeId> TranslatePaths(IEnumerable<string> paths)
vbnet
Public Function TranslatePaths(
    paths As IEnumerable(Of String)) As IEnumerable(Of OpcNodeId)

Parameters

NameTypeDescription
pathsIEnumerable<String>A sequence of string instances representing a OpcRelativePath to the OpcNodeIds requested by the service.

Returns

IEnumerable<OpcNodeId>

The target identifiers the paths could translated to.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe paths or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the paths specified.
ObjectDisposedExceptionThe object has been disposed of.

Remarks

Known results for this method are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(OpcNodeId, params string[]) ​

since v2.18

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

csharp
public IEnumerable<OpcNodeId> TranslatePaths(
    OpcNodeId nodeId,
    params string[] paths)
vbnet
Public Function TranslatePaths(
    nodeId As OpcNodeId,
    ParamArray paths As String()) As IEnumerable(Of OpcNodeId)

Parameters

NameTypeDescription
nodeIdOpcNodeIdThe OpcNodeId of the node on which the service will translate the paths.
pathsparams String[]An array of string instances representing a OpcRelativePath to the OpcNodeIds requested by the service.

Returns

IEnumerable<OpcNodeId>

The target identifiers the paths could translated to.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe paths or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the paths specified.
ObjectDisposedExceptionThe object has been disposed of.

Remarks

Known results for this method are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(OpcNodeId, IEnumerable<string>) ​

since v2.18

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

csharp
public IEnumerable<OpcNodeId> TranslatePaths(
    OpcNodeId nodeId,
    IEnumerable<string> paths)
vbnet
Public Function TranslatePaths(
    nodeId As OpcNodeId,
    paths As IEnumerable(Of String)) As IEnumerable(Of OpcNodeId)

Parameters

NameTypeDescription
nodeIdOpcNodeIdThe OpcNodeId of the node on which the service will translate the paths.
pathsIEnumerable<String>A sequence of string instances representing a OpcRelativePath to the OpcNodeIds requested by the service.

Returns

IEnumerable<OpcNodeId>

The target identifiers the paths could translated to.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe paths or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the paths specified.
ObjectDisposedExceptionThe object has been disposed of.

Remarks

Known results for this method are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(OpcNodeId, params OpcRelativePath[]) ​

since v2.18

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

csharp
public IEnumerable<OpcNodeId> TranslatePaths(
    OpcNodeId nodeId,
    params OpcRelativePath[] paths)
vbnet
Public Function TranslatePaths(
    nodeId As OpcNodeId,
    ParamArray paths As OpcRelativePath()) As IEnumerable(Of OpcNodeId)

Parameters

NameTypeDescription
nodeIdOpcNodeIdThe OpcNodeId of the node on which the service will translate the paths.
pathsparams OpcRelativePath[]An array of OpcRelativePath instances to the OpcNodeIds requested by the service.

Returns

IEnumerable<OpcNodeId>

The target identifiers the paths could translated to.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe paths or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the paths specified.
ObjectDisposedExceptionThe object has been disposed of.

Remarks

Known results for this method are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(OpcNodeId, IEnumerable<OpcRelativePath>) ​

since v2.18

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

csharp
public IEnumerable<OpcNodeId> TranslatePaths(
    OpcNodeId nodeId,
    IEnumerable<OpcRelativePath> paths)
vbnet
Public Function TranslatePaths(
    nodeId As OpcNodeId,
    paths As IEnumerable(Of OpcRelativePath)) As IEnumerable(Of OpcNodeId)

Parameters

NameTypeDescription
nodeIdOpcNodeIdThe OpcNodeId of the node on which the service will translate the paths.
pathsIEnumerable<OpcRelativePath>A sequence of OpcRelativePath instances to the OpcNodeIds requested by the service.

Returns

IEnumerable<OpcNodeId>

The target identifiers the paths could translated to.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe paths or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the paths specified.
ObjectDisposedExceptionThe object has been disposed of.

Remarks

Known results for this method are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(IEnumerable<OpcTranslatePath>) ​

since v2.18

Translates one or more paths starting from one or more dedicated nodes using the specified commands.

csharp
public OpcTranslatePathResultCollection TranslatePaths(
    IEnumerable<OpcTranslatePath> commands)
vbnet
Public Function TranslatePaths(
    commands As IEnumerable(Of OpcTranslatePath)) As OpcTranslatePathResultCollection

Parameters

NameTypeDescription
commandsIEnumerable<OpcTranslatePath>A sequence of OpcTranslatePath instances to process.

Returns

OpcTranslatePathResultCollection

An instance of the OpcTranslatePathResultCollection class which contains the target identifiers the paths were translated to through the commands specified; together with information about the outcome of each processed command.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe commands sequence or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the commands specified.

Remarks

Known results for the commands specified are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.

TranslatePaths(params OpcTranslatePath[]) ​

since v2.18

Translates one or more paths starting from one or more dedicated nodes using the specified commands.

csharp
public OpcTranslatePathResultCollection TranslatePaths(
    params OpcTranslatePath[] commands)
vbnet
Public Function TranslatePaths(
    ParamArray commands As OpcTranslatePath()) As OpcTranslatePathResultCollection

Parameters

NameTypeDescription
commandsparams OpcTranslatePath[]An array of OpcTranslatePath instances to process.

Returns

OpcTranslatePathResultCollection

An instance of the OpcTranslatePathResultCollection class which contains the target identifiers the paths were translated to through the commands specified; together with information about the outcome of each processed command.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe commands sequence or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe translate path service is currently not supported, especially using the commands specified.

Remarks

Known results for the commands specified are:

StatusDescription
BadNodeIdInvalidFor more details see BadNodeIdInvalid.
BadNodeIdUnknownFor more details see BadNodeIdUnknown.
BadNothingToDoThis code indicates that the relativePath contained an empty list.
BadBrowseNameInvalidThis code indicates that a TargetName was missing in a RelativePath.
UncertainReferenceOutOfServerThe path element has targets which are in another server.
BadTooManyMatchesThe 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.
BadQueryTooComplexThe requested operation requires too many resources in the server.
BadNoMatchThe requested relativePath cannot be resolved to a target to return.