Reference

OpcServiceResponse Members

Type

OpcServiceResponse

Namespace

Opc.UaFx.Services

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Constructors

OpcServiceResponse

protected · 3 overloads

Overload	Description
OpcServiceResponse()protected	Initializes a new instance of the OpcServiceResponse class using a new header.
OpcServiceResponse(IOpcServiceResponseHeader)protected · since v2.7	Initializes a new instance of the OpcServiceResponse class using the specified header and no diagnostic information.
OpcServiceResponse(IOpcServiceResponseHeader, DiagnosticInfoCollection)protected · since v2.7	Initializes a new instance of the OpcServiceResponse class using the specified header and diagnosticInfos.

OpcServiceResponse()

protected

Initializes a new instance of the OpcServiceResponse class using a new header.

protected OpcServiceResponse()

Protected Sub New()

OpcServiceResponse(IOpcServiceResponseHeader)

protected · since v2.7

Initializes a new instance of the OpcServiceResponse class using the specified header and no diagnostic information.

protected OpcServiceResponse(IOpcServiceResponseHeader header)

Protected Sub New(header As IOpcServiceResponseHeader)

Parameters

Name	Type	Description
header	IOpcServiceResponseHeader	The header of the response.

Exceptions

Exception	Condition
ArgumentNullException	The header is a null reference (Nothing in Visual Basic).

OpcServiceResponse(IOpcServiceResponseHeader, DiagnosticInfoCollection)

protected · since v2.7

Initializes a new instance of the OpcServiceResponse class using the specified header and diagnosticInfos.

protected OpcServiceResponse(
    IOpcServiceResponseHeader header,
    DiagnosticInfoCollection diagnosticInfos)

Protected Sub New(
    header As IOpcServiceResponseHeader,
    diagnosticInfos As DiagnosticInfoCollection)

Parameters

Name	Type	Description
header	IOpcServiceResponseHeader	The header of the response.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information of the operations of the service, or a null reference (Nothing in Visual Basic) for none.

Exceptions

Exception	Condition
ArgumentNullException	The header is a null reference (Nothing in Visual Basic).

Properties

DiagnosticInfos

since v2.7

Gets the diagnostic information of the operations of the service.

[CLSCompliant(false)]
public DiagnosticInfoCollection DiagnosticInfos { get; protected set; }

<CLSCompliant(False)>
Public Property DiagnosticInfos As DiagnosticInfoCollection

Property value

DiagnosticInfoCollection

The diagnostic information of the response.

Exception

since v2.19

Gets the exception which represents the bad result of the service.

public OpcException Exception { get; }

Public ReadOnly Property Exception As OpcException

Property value

OpcException

An OpcException of the Result of the Header if it is bad; otherwise a null reference (Nothing in Visual Basic).

Header

Gets the header of the response.

public IOpcServiceResponseHeader Header { get; }

Public ReadOnly Property Header As IOpcServiceResponseHeader

Property value

IOpcServiceResponseHeader

The IOpcServiceResponseHeader of the response.

Implements

Header

ServiceName

since v2.19

Gets the name of the service of the response.

public string ServiceName { get; }

Public ReadOnly Property ServiceName As String

Property value

String

The name of the type of the response without the prefix "Opc" and the suffix "Response" (e.g. "ReadNodes" for OpcReadNodesResponse); for a response of a service without a type of its own, the name of the service as defined by OPC UA.

Success

virtual

Gets a value indicating whether the service succeeded.

public virtual bool Success { get; }

Public Overridable ReadOnly Property Success As Boolean

Property value

Boolean

The value true if the Result of the Header is good; otherwise the value false.

Implements

Success

Remarks

An uncertain result is not a success, but there is no Exception for it.

Methods

CreateHeader

protected · since v2.7

Creates the header of the response using CreateHeaderCore and assigns it to the response.

protected IOpcServiceResponseHeader CreateHeader()

Protected Function CreateHeader() As IOpcServiceResponseHeader

Returns

IOpcServiceResponseHeader

The header created.

CreateHeaderCore

protected · virtual · since v2.7

When overridden in a derived class, creates the header of the response.

protected virtual IOpcServiceResponseHeader CreateHeaderCore()

Protected Overridable Function CreateHeaderCore() As IOpcServiceResponseHeader

Returns

IOpcServiceResponseHeader

The header created. The default implementation returns an OpcServiceResponseHeader which represents the header of the response data, or a new OpcServiceResponseHeader if the response data does not have a header.

GetResultExceptions

since v2.19

Retrieves an exception for each bad result of the operations of the service (see GetResults).

public IEnumerable<OpcException> GetResultExceptions()

Public Function GetResultExceptions() As IEnumerable(Of OpcException)

Returns

IEnumerable<OpcException>

A sequence of an OpcException for each bad result; the sequence does not contain an entry for a result which is not bad.

GetResults

abstract · since v2.19

When overridden in a derived class, retrieves the results of the operations of the service.

public abstract IEnumerable<OpcResult> GetResults()

Public MustOverride Function GetResults() As IEnumerable(Of OpcResult)

Returns

IEnumerable<OpcResult>

A sequence of the OpcResult instances of the operations.