Reference

OpcFileMethods Members

Type

OpcFileMethods

Namespace

Opc.UaFx.Client

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Methods

Close

static · 4 overloads

Overload	Description
Close(OpcFileNodeContext, uint)static	Closes the file maintained by the file node referenced by the context specified.
Close(OpcFileNodeContext, uint, OpcCallMethodOptions)static	Closes the file maintained by the file node referenced by the context specified.
Close(OpcClient, OpcNodeId, uint)static	Closes the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.
Close(OpcClient, OpcNodeId, uint, OpcCallMethodOptions)static	Closes the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The file node does not exist.
NotSupportedException	The 'Close' method node does not exist or the method node signature does not define a valid method node to close a file handle.
OpcException	The call of the method node failed (see exception details for more information).

Close(OpcFileNodeContext, uint)

static

Closes the file maintained by the file node referenced by the context specified.

[CLSCompliant(false)]
public static void Close(OpcFileNodeContext context, uint fileHandle)

<CLSCompliant(False)>
Public Shared Sub Close(context As OpcFileNodeContext, fileHandle As UInteger)

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.

Exceptions

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

Close(OpcFileNodeContext, uint, OpcCallMethodOptions)

static

Closes the file maintained by the file node referenced by the context specified.

[CLSCompliant(false)]
public static void Close(
    OpcFileNodeContext context,
    uint fileHandle,
    OpcCallMethodOptions options)

<CLSCompliant(False)>
Public Shared Sub Close(
    context As OpcFileNodeContext,
    fileHandle As UInteger,
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to close the file handle.

Exceptions

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

Close(OpcClient, OpcNodeId, uint)

static

Closes the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

[CLSCompliant(false)]
public static void Close(
    OpcClient client,
    OpcNodeId fileNodeId,
    uint fileHandle)

<CLSCompliant(False)>
Public Shared Sub Close(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As UInteger)

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Close' method is to be called.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.

Exceptions

Exception	Condition
ArgumentNullException	The client or fileNodeId is a null reference (Nothing in Visual Basic).

Close(OpcClient, OpcNodeId, uint, OpcCallMethodOptions)

static

Closes the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

[CLSCompliant(false)]
public static void Close(
    OpcClient client,
    OpcNodeId fileNodeId,
    uint fileHandle,
    OpcCallMethodOptions options)

<CLSCompliant(False)>
Public Shared Sub Close(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As UInteger,
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Close' method is to be called.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to close the file handle.

Exceptions

Exception	Condition
ArgumentNullException	The client or fileNodeId is a null reference (Nothing in Visual Basic).

GetPosition

static · 4 overloads

Overload	Description
GetPosition(OpcFileNodeContext, uint)static	Retrieves the position within the file maintained by the file node referenced by the context specified.
GetPosition(OpcFileNodeContext, uint, OpcCallMethodOptions)static	Retrieves the position within the file maintained by the file node referenced by the context specified.
GetPosition(OpcClient, OpcNodeId, uint)static	Retrieves the position within the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.
GetPosition(OpcClient, OpcNodeId, uint, OpcCallMethodOptions)static	Retrieves the position within the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The file node does not exist.
NotSupportedException	The 'GetPosition' method node does not exist or the method node signature does not define a valid method node to query the position in a file.
OpcException	The call of the method node failed (see exception details for more information).

GetPosition(OpcFileNodeContext, uint)

static

Retrieves the position within the file maintained by the file node referenced by the context specified.

[CLSCompliant(false)]
public static ulong GetPosition(OpcFileNodeContext context, uint fileHandle)

<CLSCompliant(False)>
Public Shared Function GetPosition(
    context As OpcFileNodeContext,
    fileHandle As UInteger) As ULong

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.

Returns

UInt64

The current position in the file.

Exceptions

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

GetPosition(OpcFileNodeContext, uint, OpcCallMethodOptions)

static

Retrieves the position within the file maintained by the file node referenced by the context specified.

[CLSCompliant(false)]
public static ulong GetPosition(
    OpcFileNodeContext context,
    uint fileHandle,
    OpcCallMethodOptions options)

<CLSCompliant(False)>
Public Shared Function GetPosition(
    context As OpcFileNodeContext,
    fileHandle As UInteger,
    options As OpcCallMethodOptions) As ULong

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to query the position in a file.

Returns

UInt64

The current position in the file.

Exceptions

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

GetPosition(OpcClient, OpcNodeId, uint)

static

Retrieves the position within the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

[CLSCompliant(false)]
public static ulong GetPosition(
    OpcClient client,
    OpcNodeId fileNodeId,
    uint fileHandle)

<CLSCompliant(False)>
Public Shared Function GetPosition(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As UInteger) As ULong

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'GetPosition' method node is to be called.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.

Returns

UInt64

The current position in the file.

Exceptions

Exception	Condition
ArgumentNullException	The client or fileNodeId is a null reference (Nothing in Visual Basic).

GetPosition(OpcClient, OpcNodeId, uint, OpcCallMethodOptions)

static

Retrieves the position within the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

[CLSCompliant(false)]
public static ulong GetPosition(
    OpcClient client,
    OpcNodeId fileNodeId,
    uint fileHandle,
    OpcCallMethodOptions options)

<CLSCompliant(False)>
Public Shared Function GetPosition(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As UInteger,
    options As OpcCallMethodOptions) As ULong

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'GetPosition' method node is to be called.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to query the position in a file.

Returns

UInt64

The current position in the file.

Exceptions

Exception	Condition
ArgumentNullException	The client or fileNodeId is a null reference (Nothing in Visual Basic).

IsFileNode

static · 2 overloads

Overload	Description
IsFileNode(OpcFileNodeContext)static	Inspects the file node referenced by the context specified whether the node fulfills the requirements of accessing it in the manner of a OPC UA FileType.
IsFileNode(OpcClient, OpcNodeId)static	Inspects the file node referenced by the fileNodeId specified using the further specified OpcClient whether the node fulfills the requirements of accessing it in the manner of a OPC UA FileType.

IsFileNode(OpcFileNodeContext)

static

Inspects the file node referenced by the context specified whether the node fulfills the requirements of accessing it in the manner of a OPC UA FileType.

public static bool IsFileNode(OpcFileNodeContext context)

Public Shared Function IsFileNode(context As OpcFileNodeContext) As Boolean

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to inspect the supposed file node.

Returns

Boolean

The value true if the supposed file node is concrete file node; otherwise the value false.

Exceptions

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

IsFileNode(OpcClient, OpcNodeId)

static

Inspects the file node referenced by the fileNodeId specified using the further specified OpcClient whether the node fulfills the requirements of accessing it in the manner of a OPC UA FileType.

public static bool IsFileNode(OpcClient client, OpcNodeId fileNodeId)

Public Shared Function IsFileNode(
    client As OpcClient,
    fileNodeId As OpcNodeId) As Boolean

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Open' method node is to be called.

Returns

Boolean

The value true if the supposed file node is concrete file node; otherwise the value false.

Exceptions

Exception	Condition
ArgumentNullException	The client or fileNodeId is a null reference (Nothing in Visual Basic).

Open

static · 4 overloads

Overload	Description
Open(OpcFileNodeContext, OpcFileMode)static	Opens the file maintained by the file node referenced by the context specified.
Open(OpcFileNodeContext, OpcFileMode, OpcCallMethodOptions)static	Opens the file maintained by the file node referenced by the context specified.
Open(OpcClient, OpcNodeId, OpcFileMode)static	Opens the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.
Open(OpcClient, OpcNodeId, OpcFileMode, OpcCallMethodOptions)static	Opens the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The file node does not exist.
NotSupportedException	The 'Open' method node does not exist or the method node signature does not define a valid method node to open a file handle.
OpcException	The call of the method node failed (see exception details for more information).

Open(OpcFileNodeContext, OpcFileMode)

static

Opens the file maintained by the file node referenced by the context specified.

[CLSCompliant(false)]
public static uint Open(OpcFileNodeContext context, OpcFileMode mode)

<CLSCompliant(False)>
Public Shared Function Open(
    context As OpcFileNodeContext,
    mode As OpcFileMode) As UInteger

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
mode	OpcFileMode	One of the OpcFileMode members or a combination of them. The value defines the type of requested access and how the system should open an existing file.

Returns

UInt32

The session based file handle to use to identify the file access requested for subsequent file method calls. To release the acquired file handle call one of the Close methods.

Exceptions

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

Open(OpcFileNodeContext, OpcFileMode, OpcCallMethodOptions)

static

Opens the file maintained by the file node referenced by the context specified.

[CLSCompliant(false)]
public static uint Open(
    OpcFileNodeContext context,
    OpcFileMode mode,
    OpcCallMethodOptions options)

<CLSCompliant(False)>
Public Shared Function Open(
    context As OpcFileNodeContext,
    mode As OpcFileMode,
    options As OpcCallMethodOptions) As UInteger

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
mode	OpcFileMode	One of the OpcFileMode members or a combination of them. The value defines the type of requested access and how the system should open an existing file.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to open a file handle.

Returns

UInt32

The session based file handle to use to identify the file access requested for subsequent file method calls. To release the acquired file handle call one of the Close methods.

Exceptions

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

Open(OpcClient, OpcNodeId, OpcFileMode)

static

Opens the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

[CLSCompliant(false)]
public static uint Open(
    OpcClient client,
    OpcNodeId fileNodeId,
    OpcFileMode mode)

<CLSCompliant(False)>
Public Shared Function Open(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    mode As OpcFileMode) As UInteger

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Open' method node is to be called.
mode	OpcFileMode	One of the OpcFileMode members or a combination of them. The value defines the type of requested access and how the system should open an existing file.

Returns

UInt32

The session based file handle to use to identify the file access requested for subsequent file method calls. To release the acquired file handle call one of the Close methods.

Exceptions

Exception	Condition
ArgumentNullException	The client or fileNodeId is a null reference (Nothing in Visual Basic).

Open(OpcClient, OpcNodeId, OpcFileMode, OpcCallMethodOptions)

static

Opens the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

[CLSCompliant(false)]
public static uint Open(
    OpcClient client,
    OpcNodeId fileNodeId,
    OpcFileMode mode,
    OpcCallMethodOptions options)

<CLSCompliant(False)>
Public Shared Function Open(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    mode As OpcFileMode,
    options As OpcCallMethodOptions) As UInteger

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Open' method node is to be called.
mode	OpcFileMode	One of the OpcFileMode members or a combination of them. The value defines the type of requested access and how the system should open an existing file.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to open a file handle.

Returns

UInt32

The session based file handle to use to identify the file access requested for subsequent file method calls. To release the acquired file handle call one of the Close methods.

Exceptions

Exception	Condition
ArgumentNullException	The client or fileNodeId is a null reference (Nothing in Visual Basic).

Read

static · 4 overloads

Overload	Description
Read(OpcFileNodeContext, uint, int)static	Reads the number of bytes specified by length from the file maintained by the file node referenced by the context specified.
Read(OpcFileNodeContext, uint, int, OpcCallMethodOptions)static	Reads the number of bytes specified by length from the file maintained by the file node referenced by the context specified.
Read(OpcClient, OpcNodeId, uint, int)static	Reads the number of bytes specified by length from the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.
Read(OpcClient, OpcNodeId, uint, int, OpcCallMethodOptions)static	Reads the number of bytes specified by length from the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The file node does not exist.
NotSupportedException	The 'Read' method node does not exist or the method node signature does not define a valid method node to read data from a file.
OpcException	The call of the method node failed (see exception details for more information).

Read(OpcFileNodeContext, uint, int)

static

Reads the number of bytes specified by length from the file maintained by the file node referenced by the context specified.

[CLSCompliant(false)]
public static byte[] Read(
    OpcFileNodeContext context,
    uint fileHandle,
    int length)

<CLSCompliant(False)>
Public Shared Function Read(
    context As OpcFileNodeContext,
    fileHandle As UInteger,
    length As Integer) As Byte()

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
length	Int32	The number of bytes to read starting from the current position in the file.

Returns

Byte[]

The data read from the file. If the end of file is reached only the data till the end of the file is read. If the specified length is longer than the maximum allowed message size of the communication, only those data fitting into the message size is read.

Exceptions

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

Read(OpcFileNodeContext, uint, int, OpcCallMethodOptions)

static

Reads the number of bytes specified by length from the file maintained by the file node referenced by the context specified.

[CLSCompliant(false)]
public static byte[] Read(
    OpcFileNodeContext context,
    uint fileHandle,
    int length,
    OpcCallMethodOptions options)

<CLSCompliant(False)>
Public Shared Function Read(
    context As OpcFileNodeContext,
    fileHandle As UInteger,
    length As Integer,
    options As OpcCallMethodOptions) As Byte()

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
length	Int32	The number of bytes to read starting from the current position in the file.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to read data from a file.

Returns

Byte[]

The data read from the file. If the end of file is reached only the data till the end of the file is read. If the specified length is longer than the maximum allowed message size of the communication, only those data fitting into the message size is read.

Exceptions

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

Read(OpcClient, OpcNodeId, uint, int)

static

Reads the number of bytes specified by length from the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

[CLSCompliant(false)]
public static byte[] Read(
    OpcClient client,
    OpcNodeId fileNodeId,
    uint fileHandle,
    int length)

<CLSCompliant(False)>
Public Shared Function Read(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As UInteger,
    length As Integer) As Byte()

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Read' method node is to be called.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
length	Int32	The number of bytes to read starting from the current position in the file.

Returns

Byte[]

The data read from the file. If the end of file is reached only the data till the end of the file is read. If the specified length is longer than the maximum allowed message size of the communication, only those data fitting into the message size is read.

Exceptions

Exception	Condition
ArgumentNullException	The client or fileNodeId is a null reference (Nothing in Visual Basic).

Read(OpcClient, OpcNodeId, uint, int, OpcCallMethodOptions)

static

Reads the number of bytes specified by length from the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

[CLSCompliant(false)]
public static byte[] Read(
    OpcClient client,
    OpcNodeId fileNodeId,
    uint fileHandle,
    int length,
    OpcCallMethodOptions options)

<CLSCompliant(False)>
Public Shared Function Read(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As UInteger,
    length As Integer,
    options As OpcCallMethodOptions) As Byte()

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Read' method node is to be called.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
length	Int32	The number of bytes to read starting from the current position in the file.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to read data from a file.

Returns

Byte[]

The data read from the file. If the end of file is reached only the data till the end of the file is read. If the specified length is longer than the maximum allowed message size of the communication, only those data fitting into the message size is read.

Exceptions

Exception	Condition
ArgumentNullException	The client or fileNodeId is a null reference (Nothing in Visual Basic).

SecureClose

static · 6 overloads

Overload	Description
SecureClose(SafeOpcFileHandle)static	Closes the file fileHandle specified.
SecureClose(SafeOpcFileHandle, OpcCallMethodOptions)static	Closes the file fileHandle specified.
SecureClose(OpcFileNodeContext, SafeOpcFileHandle)static	Closes the file maintained by the file node referenced by the context specified.
SecureClose(OpcFileNodeContext, SafeOpcFileHandle, OpcCallMethodOptions)static	Closes the file maintained by the file node referenced by the context specified.
SecureClose(OpcClient, OpcNodeId, SafeOpcFileHandle)static	Closes the file maintained by the file node referenced by the nodeId specified using the further specified OpcClient.
SecureClose(OpcClient, OpcNodeId, SafeOpcFileHandle, OpcCallMethodOptions)static	Closes the file maintained by the file node referenced by the nodeId specified using the further specified OpcClient.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The file node does not exist.
NotSupportedException	The 'Close' method node does not exist or the method node signature does not define a valid method node to close a file handle.
OpcException	The call of the method node failed (see exception details for more information).

SecureClose(SafeOpcFileHandle)

static

Closes the file fileHandle specified.

public static void SecureClose(SafeOpcFileHandle fileHandle)

Public Shared Sub SecureClose(fileHandle As SafeOpcFileHandle)

Parameters

Name	Type	Description
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.

Exceptions

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

SecureClose(SafeOpcFileHandle, OpcCallMethodOptions)

static

Closes the file fileHandle specified.

public static void SecureClose(
    SafeOpcFileHandle fileHandle,
    OpcCallMethodOptions options)

Public Shared Sub SecureClose(
    fileHandle As SafeOpcFileHandle,
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to close the file handle.

Exceptions

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

SecureClose(OpcFileNodeContext, SafeOpcFileHandle)

static

Closes the file maintained by the file node referenced by the context specified.

public static void SecureClose(
    OpcFileNodeContext context,
    SafeOpcFileHandle fileHandle)

Public Shared Sub SecureClose(
    context As OpcFileNodeContext,
    fileHandle As SafeOpcFileHandle)

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.

Exceptions

Exception	Condition
ArgumentNullException	The context or fileHandle is a null reference (Nothing in Visual Basic).

SecureClose(OpcFileNodeContext, SafeOpcFileHandle, OpcCallMethodOptions)

static

Closes the file maintained by the file node referenced by the context specified.

public static void SecureClose(
    OpcFileNodeContext context,
    SafeOpcFileHandle fileHandle,
    OpcCallMethodOptions options)

Public Shared Sub SecureClose(
    context As OpcFileNodeContext,
    fileHandle As SafeOpcFileHandle,
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to close the file handle.

Exceptions

Exception	Condition
ArgumentNullException	The context or fileHandle is a null reference (Nothing in Visual Basic).

SecureClose(OpcClient, OpcNodeId, SafeOpcFileHandle)

static

Closes the file maintained by the file node referenced by the nodeId specified using the further specified OpcClient.

public static void SecureClose(
    OpcClient client,
    OpcNodeId nodeId,
    SafeOpcFileHandle fileHandle)

Public Shared Sub SecureClose(
    client As OpcClient,
    nodeId As OpcNodeId,
    fileHandle As SafeOpcFileHandle)

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
nodeId	OpcNodeId	The OpcNodeId of the file node its 'Close' method is to be called.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.

Exceptions

Exception	Condition
ArgumentNullException	The client, nodeId or fileHandle is a null reference (Nothing in Visual Basic).

SecureClose(OpcClient, OpcNodeId, SafeOpcFileHandle, OpcCallMethodOptions)

static

Closes the file maintained by the file node referenced by the nodeId specified using the further specified OpcClient.

public static void SecureClose(
    OpcClient client,
    OpcNodeId nodeId,
    SafeOpcFileHandle fileHandle,
    OpcCallMethodOptions options)

Public Shared Sub SecureClose(
    client As OpcClient,
    nodeId As OpcNodeId,
    fileHandle As SafeOpcFileHandle,
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
nodeId	OpcNodeId	The OpcNodeId of the file node its 'Close' method is to be called.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to close the file handle.

Exceptions

Exception	Condition
ArgumentNullException	The client, nodeId or fileHandle is a null reference (Nothing in Visual Basic).

SecureGetPosition

static · 6 overloads

Overload	Description
SecureGetPosition(SafeOpcFileHandle)static	Retrieves the position within the file identified by the fileHandle specified.
SecureGetPosition(SafeOpcFileHandle, OpcCallMethodOptions)static	Retrieves the position within the file identified by the fileHandle specified.
SecureGetPosition(OpcFileNodeContext, SafeOpcFileHandle)static	Retrieves the position within the file maintained by the file node referenced by the context specified.
SecureGetPosition(OpcFileNodeContext, SafeOpcFileHandle, OpcCallMethodOptions)static	Retrieves the position within the file maintained by the file node referenced by the context specified.
SecureGetPosition(OpcClient, OpcNodeId, SafeOpcFileHandle)static	Retrieves the position within the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.
SecureGetPosition(OpcClient, OpcNodeId, SafeOpcFileHandle, OpcCallMethodOptions)static	Retrieves the position within the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The file node does not exist.
NotSupportedException	The 'GetPosition' method node does not exist or the method node signature does not define a valid method node to query the position in a file.
OpcException	The call of the method node failed (see exception details for more information).

SecureGetPosition(SafeOpcFileHandle)

static

Retrieves the position within the file identified by the fileHandle specified.

public static long SecureGetPosition(SafeOpcFileHandle fileHandle)

Public Shared Function SecureGetPosition(
    fileHandle As SafeOpcFileHandle) As Long

Parameters

Name	Type	Description
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.

Returns

Int64

The current position in the file.

Exceptions

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

SecureGetPosition(SafeOpcFileHandle, OpcCallMethodOptions)

static

Retrieves the position within the file identified by the fileHandle specified.

public static long SecureGetPosition(
    SafeOpcFileHandle fileHandle,
    OpcCallMethodOptions options)

Public Shared Function SecureGetPosition(
    fileHandle As SafeOpcFileHandle,
    options As OpcCallMethodOptions) As Long

Parameters

Name	Type	Description
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to query the position in a file.

Returns

Int64

The current position in the file.

Exceptions

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

SecureGetPosition(OpcFileNodeContext, SafeOpcFileHandle)

static

Retrieves the position within the file maintained by the file node referenced by the context specified.

public static long SecureGetPosition(
    OpcFileNodeContext context,
    SafeOpcFileHandle fileHandle)

Public Shared Function SecureGetPosition(
    context As OpcFileNodeContext,
    fileHandle As SafeOpcFileHandle) As Long

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.

Returns

Int64

The current position in the file.

Exceptions

Exception	Condition
ArgumentNullException	The context or fileHandle is a null reference (Nothing in Visual Basic).

SecureGetPosition(OpcFileNodeContext, SafeOpcFileHandle, OpcCallMethodOptions)

static

Retrieves the position within the file maintained by the file node referenced by the context specified.

public static long SecureGetPosition(
    OpcFileNodeContext context,
    SafeOpcFileHandle fileHandle,
    OpcCallMethodOptions options)

Public Shared Function SecureGetPosition(
    context As OpcFileNodeContext,
    fileHandle As SafeOpcFileHandle,
    options As OpcCallMethodOptions) As Long

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to query the position in a file.

Returns

Int64

The current position in the file.

Exceptions

Exception	Condition
ArgumentNullException	The context or fileHandle is a null reference (Nothing in Visual Basic).

SecureGetPosition(OpcClient, OpcNodeId, SafeOpcFileHandle)

static

Retrieves the position within the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

public static long SecureGetPosition(
    OpcClient client,
    OpcNodeId fileNodeId,
    SafeOpcFileHandle fileHandle)

Public Shared Function SecureGetPosition(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As SafeOpcFileHandle) As Long

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'GetPosition' method node is to be called.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.

Returns

Int64

The current position in the file.

Exceptions

Exception	Condition
ArgumentNullException	The client, fileNodeId or fileHandle is a null reference (Nothing in Visual Basic).

SecureGetPosition(OpcClient, OpcNodeId, SafeOpcFileHandle, OpcCallMethodOptions)

static

Retrieves the position within the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

public static long SecureGetPosition(
    OpcClient client,
    OpcNodeId fileNodeId,
    SafeOpcFileHandle fileHandle,
    OpcCallMethodOptions options)

Public Shared Function SecureGetPosition(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As SafeOpcFileHandle,
    options As OpcCallMethodOptions) As Long

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'GetPosition' method node is to be called.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to query the position in a file.

Returns

Int64

The current position in the file.

Exceptions

Exception	Condition
ArgumentNullException	The client, fileNodeId or fileHandle is a null reference (Nothing in Visual Basic).

SecureOpen

static · 4 overloads

Overload	Description
SecureOpen(OpcFileNodeContext, OpcFileMode)static	Opens the file maintained by the file node referenced by the context specified.
SecureOpen(OpcFileNodeContext, OpcFileMode, OpcCallMethodOptions)static	Opens the file maintained by the file node referenced by the context specified.
SecureOpen(OpcClient, OpcNodeId, OpcFileMode)static	Opens the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.
SecureOpen(OpcClient, OpcNodeId, OpcFileMode, OpcCallMethodOptions)static	Opens the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The file node does not exist.
NotSupportedException	The 'Open' method node does not exist or the method node signature does not define a valid method node to open a file handle.
OpcException	The call of the method node failed (see exception details for more information).

SecureOpen(OpcFileNodeContext, OpcFileMode)

static

Opens the file maintained by the file node referenced by the context specified.

public static SafeOpcFileHandle SecureOpen(
    OpcFileNodeContext context,
    OpcFileMode mode)

Public Shared Function SecureOpen(
    context As OpcFileNodeContext,
    mode As OpcFileMode) As SafeOpcFileHandle

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
mode	OpcFileMode	One of the OpcFileMode members or a combination of them. The value defines the type of requested access and how the system should open an existing file.

Returns

SafeOpcFileHandle

The session based SafeOpcFileHandle to use to identify the file access requested for subsequent file method calls. To release the acquired file handle call one of the SecureClose methods or call the 'Close' method of the handle provided.

Exceptions

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

SecureOpen(OpcFileNodeContext, OpcFileMode, OpcCallMethodOptions)

static

Opens the file maintained by the file node referenced by the context specified.

public static SafeOpcFileHandle SecureOpen(
    OpcFileNodeContext context,
    OpcFileMode mode,
    OpcCallMethodOptions options)

Public Shared Function SecureOpen(
    context As OpcFileNodeContext,
    mode As OpcFileMode,
    options As OpcCallMethodOptions) As SafeOpcFileHandle

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
mode	OpcFileMode	One of the OpcFileMode members or a combination of them. The value defines the type of requested access and how the system should open an existing file.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to open a file handle.

Returns

SafeOpcFileHandle

The session based SafeOpcFileHandle to use to identify the file access requested for subsequent file method calls. To release the acquired file handle call one of the SecureClose methods or call the 'Close' method of the handle provided.

Exceptions

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

SecureOpen(OpcClient, OpcNodeId, OpcFileMode)

static

Opens the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

public static SafeOpcFileHandle SecureOpen(
    OpcClient client,
    OpcNodeId fileNodeId,
    OpcFileMode mode)

Public Shared Function SecureOpen(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    mode As OpcFileMode) As SafeOpcFileHandle

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Open' method node is to be called.
mode	OpcFileMode	One of the OpcFileMode members or a combination of them. The value defines the type of requested access and how the system should open an existing file.

Returns

SafeOpcFileHandle

The session based SafeOpcFileHandle to use to identify the file access requested for subsequent file method calls. To release the acquired file handle call one of the SecureClose methods or call the 'Close' method of the handle provided.

Exceptions

Exception	Condition
ArgumentNullException	The client or fileNodeId is a null reference (Nothing in Visual Basic).

SecureOpen(OpcClient, OpcNodeId, OpcFileMode, OpcCallMethodOptions)

static

Opens the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

public static SafeOpcFileHandle SecureOpen(
    OpcClient client,
    OpcNodeId fileNodeId,
    OpcFileMode mode,
    OpcCallMethodOptions options)

Public Shared Function SecureOpen(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    mode As OpcFileMode,
    options As OpcCallMethodOptions) As SafeOpcFileHandle

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Open' method node is to be called.
mode	OpcFileMode	One of the OpcFileMode members or a combination of them. The value defines the type of requested access and how the system should open an existing file.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to open a file handle.

Returns

SafeOpcFileHandle

The session based SafeOpcFileHandle to use to identify the file access requested for subsequent file method calls. To release the acquired file handle call one of the SecureClose methods or call the 'Close' method of the handle provided.

Exceptions

Exception	Condition
ArgumentNullException	The client or fileNodeId is a null reference (Nothing in Visual Basic).

SecureRead

static · 6 overloads

Overload	Description
SecureRead(SafeOpcFileHandle, int)static	Reads the number of bytes specified by length from the file identified by the fileHandle specified.
SecureRead(SafeOpcFileHandle, int, OpcCallMethodOptions)static	Reads the number of bytes specified by length from the file identified by the fileHandle specified.
SecureRead(OpcFileNodeContext, SafeOpcFileHandle, int)static	Reads the number of bytes specified by length from the file maintained by the file node referenced by the context specified.
SecureRead(OpcFileNodeContext, SafeOpcFileHandle, int, OpcCallMethodOptions)static	Reads the number of bytes specified by length from the file maintained by the file node referenced by the context specified.
SecureRead(OpcClient, OpcNodeId, SafeOpcFileHandle, int)static	Reads the number of bytes specified by length from the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.
SecureRead(OpcClient, OpcNodeId, SafeOpcFileHandle, int, OpcCallMethodOptions)static	Reads the number of bytes specified by length from the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The file node does not exist.
NotSupportedException	The 'Read' method node does not exist or the method node signature does not define a valid method node to read data from a file.
OpcException	The call of the method node failed (see exception details for more information).

SecureRead(SafeOpcFileHandle, int)

static

Reads the number of bytes specified by length from the file identified by the fileHandle specified.

public static byte[] SecureRead(SafeOpcFileHandle fileHandle, int length)

Public Shared Function SecureRead(
    fileHandle As SafeOpcFileHandle,
    length As Integer) As Byte()

Parameters

Name	Type	Description
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
length	Int32	The number of bytes to read starting from the current position in the file.

Returns

Byte[]

The data read from the file. If the end of file is reached only the data till the end of the file is read. If the specified length is longer than the maximum allowed message size of the communication, only those data fitting into the message size is read.

Exceptions

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

SecureRead(SafeOpcFileHandle, int, OpcCallMethodOptions)

static

Reads the number of bytes specified by length from the file identified by the fileHandle specified.

public static byte[] SecureRead(
    SafeOpcFileHandle fileHandle,
    int length,
    OpcCallMethodOptions options)

Public Shared Function SecureRead(
    fileHandle As SafeOpcFileHandle,
    length As Integer,
    options As OpcCallMethodOptions) As Byte()

Parameters

Name	Type	Description
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
length	Int32	The number of bytes to read starting from the current position in the file.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to read data from a file.

Returns

Byte[]

The data read from the file. If the end of file is reached only the data till the end of the file is read. If the specified length is longer than the maximum allowed message size of the communication, only those data fitting into the message size is read.

Exceptions

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

SecureRead(OpcFileNodeContext, SafeOpcFileHandle, int)

static

Reads the number of bytes specified by length from the file maintained by the file node referenced by the context specified.

public static byte[] SecureRead(
    OpcFileNodeContext context,
    SafeOpcFileHandle fileHandle,
    int length)

Public Shared Function SecureRead(
    context As OpcFileNodeContext,
    fileHandle As SafeOpcFileHandle,
    length As Integer) As Byte()

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
length	Int32	The number of bytes to read starting from the current position in the file.

Returns

Byte[]

The data read from the file. If the end of file is reached only the data till the end of the file is read. If the specified length is longer than the maximum allowed message size of the communication, only those data fitting into the message size is read.

Exceptions

Exception	Condition
ArgumentNullException	The context or fileHandle is a null reference (Nothing in Visual Basic).

SecureRead(OpcFileNodeContext, SafeOpcFileHandle, int, OpcCallMethodOptions)

static

Reads the number of bytes specified by length from the file maintained by the file node referenced by the context specified.

public static byte[] SecureRead(
    OpcFileNodeContext context,
    SafeOpcFileHandle fileHandle,
    int length,
    OpcCallMethodOptions options)

Public Shared Function SecureRead(
    context As OpcFileNodeContext,
    fileHandle As SafeOpcFileHandle,
    length As Integer,
    options As OpcCallMethodOptions) As Byte()

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
length	Int32	The number of bytes to read starting from the current position in the file.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to read data from a file.

Returns

Byte[]

The data read from the file. If the end of file is reached only the data till the end of the file is read. If the specified length is longer than the maximum allowed message size of the communication, only those data fitting into the message size is read.

Exceptions

Exception	Condition
ArgumentNullException	The context or fileHandle is a null reference (Nothing in Visual Basic).

SecureRead(OpcClient, OpcNodeId, SafeOpcFileHandle, int)

static

Reads the number of bytes specified by length from the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

public static byte[] SecureRead(
    OpcClient client,
    OpcNodeId fileNodeId,
    SafeOpcFileHandle fileHandle,
    int length)

Public Shared Function SecureRead(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As SafeOpcFileHandle,
    length As Integer) As Byte()

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Read' method node is to be called.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
length	Int32	The number of bytes to read starting from the current position in the file.

Returns

Byte[]

The data read from the file. If the end of file is reached only the data till the end of the file is read. If the specified length is longer than the maximum allowed message size of the communication, only those data fitting into the message size is read.

Exceptions

Exception	Condition
ArgumentNullException	The client, fileNodeId or fileHandle is a null reference (Nothing in Visual Basic).

SecureRead(OpcClient, OpcNodeId, SafeOpcFileHandle, int, OpcCallMethodOptions)

static

Reads the number of bytes specified by length from the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

public static byte[] SecureRead(
    OpcClient client,
    OpcNodeId fileNodeId,
    SafeOpcFileHandle fileHandle,
    int length,
    OpcCallMethodOptions options)

Public Shared Function SecureRead(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As SafeOpcFileHandle,
    length As Integer,
    options As OpcCallMethodOptions) As Byte()

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Read' method node is to be called.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
length	Int32	The number of bytes to read starting from the current position in the file.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to read data from a file.

Returns

Byte[]

The data read from the file. If the end of file is reached only the data till the end of the file is read. If the specified length is longer than the maximum allowed message size of the communication, only those data fitting into the message size is read.

Exceptions

Exception	Condition
ArgumentNullException	The client, fileNodeId or fileHandle is a null reference (Nothing in Visual Basic).

SecureSetPosition

static · 6 overloads

Overload	Description
SecureSetPosition(SafeOpcFileHandle, long)static	Updates the position in the file identified by the fileHandle specified using position.
SecureSetPosition(SafeOpcFileHandle, long, OpcCallMethodOptions)static	Updates the position in the file identified by the fileHandle specified using position.
SecureSetPosition(OpcFileNodeContext, SafeOpcFileHandle, long)static	Updates the position in the file maintained by the file node referenced by the context specified using position.
SecureSetPosition(OpcFileNodeContext, SafeOpcFileHandle, long, OpcCallMethodOptions)static	Updates the position in the file maintained by the file node referenced by the context specified using position.
SecureSetPosition(OpcClient, OpcNodeId, SafeOpcFileHandle, long)static	Updates the position in the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient using position.
SecureSetPosition(OpcClient, OpcNodeId, SafeOpcFileHandle, long, OpcCallMethodOptions)static	Updates the position in the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient using position.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The file node does not exist.
NotSupportedException	The 'SetPosition' method node does not exist or the method node signature does not define a valid method node to update the position in a file.
OpcException	The call of the method node failed (see exception details for more information).

SecureSetPosition(SafeOpcFileHandle, long)

static

Updates the position in the file identified by the fileHandle specified using position.

public static void SecureSetPosition(
    SafeOpcFileHandle fileHandle,
    long position)

Public Shared Sub SecureSetPosition(
    fileHandle As SafeOpcFileHandle,
    position As Long)

Parameters

Name	Type	Description
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
position	Int64	The new position in the file. If position is greater than the file size the position is set to the end of the file.

Exceptions

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

SecureSetPosition(SafeOpcFileHandle, long, OpcCallMethodOptions)

static

Updates the position in the file identified by the fileHandle specified using position.

public static void SecureSetPosition(
    SafeOpcFileHandle fileHandle,
    long position,
    OpcCallMethodOptions options)

Public Shared Sub SecureSetPosition(
    fileHandle As SafeOpcFileHandle,
    position As Long,
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
position	Int64	The new position in the file. If position is greater than the file size the position is set to the end of the file.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to update the position in a file.

Exceptions

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

SecureSetPosition(OpcFileNodeContext, SafeOpcFileHandle, long)

static

Updates the position in the file maintained by the file node referenced by the context specified using position.

public static void SecureSetPosition(
    OpcFileNodeContext context,
    SafeOpcFileHandle fileHandle,
    long position)

Public Shared Sub SecureSetPosition(
    context As OpcFileNodeContext,
    fileHandle As SafeOpcFileHandle,
    position As Long)

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
position	Int64	The new position in the file. If position is greater than the file size the position is set to the end of the file.

Exceptions

Exception	Condition
ArgumentNullException	The context or fileHandle is a null reference (Nothing in Visual Basic).

SecureSetPosition(OpcFileNodeContext, SafeOpcFileHandle, long, OpcCallMethodOptions)

static

Updates the position in the file maintained by the file node referenced by the context specified using position.

public static void SecureSetPosition(
    OpcFileNodeContext context,
    SafeOpcFileHandle fileHandle,
    long position,
    OpcCallMethodOptions options)

Public Shared Sub SecureSetPosition(
    context As OpcFileNodeContext,
    fileHandle As SafeOpcFileHandle,
    position As Long,
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
position	Int64	The new position in the file. If position is greater than the file size the position is set to the end of the file.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to update the position in a file.

Exceptions

Exception	Condition
ArgumentNullException	The context or fileHandle is a null reference (Nothing in Visual Basic).

SecureSetPosition(OpcClient, OpcNodeId, SafeOpcFileHandle, long)

static

Updates the position in the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient using position.

public static void SecureSetPosition(
    OpcClient client,
    OpcNodeId fileNodeId,
    SafeOpcFileHandle fileHandle,
    long position)

Public Shared Sub SecureSetPosition(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As SafeOpcFileHandle,
    position As Long)

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'SetPosition' method node is to be called.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
position	Int64	The new position in the file. If position is greater than the file size the position is set to the end of the file.

Exceptions

Exception	Condition
ArgumentNullException	The client, fileNodeId or fileHandle is a null reference (Nothing in Visual Basic).

SecureSetPosition(OpcClient, OpcNodeId, SafeOpcFileHandle, long, OpcCallMethodOptions)

static

Updates the position in the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient using position.

public static void SecureSetPosition(
    OpcClient client,
    OpcNodeId fileNodeId,
    SafeOpcFileHandle fileHandle,
    long position,
    OpcCallMethodOptions options)

Public Shared Sub SecureSetPosition(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As SafeOpcFileHandle,
    position As Long,
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'SetPosition' method node is to be called.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
position	Int64	The new position in the file. If position is greater than the file size the position is set to the end of the file.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to update the position in a file.

Exceptions

Exception	Condition
ArgumentNullException	The client, fileNodeId or fileHandle is a null reference (Nothing in Visual Basic).

SecureWrite

static · 6 overloads

Overload	Description
SecureWrite(SafeOpcFileHandle, byte[])static	Writes the data to the file identified by the fileHandle specified.
SecureWrite(SafeOpcFileHandle, byte[], OpcCallMethodOptions)static	Writes the data to the file identified by the fileHandle specified.
SecureWrite(OpcFileNodeContext, SafeOpcFileHandle, byte[])static	Writes the data to the file maintained by the file node referenced by the context specified.
SecureWrite(OpcFileNodeContext, SafeOpcFileHandle, byte[], OpcCallMethodOptions)static	Writes the data to the file maintained by the file node referenced by the context specified.
SecureWrite(OpcClient, OpcNodeId, SafeOpcFileHandle, byte[])static	Writes the data to the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.
SecureWrite(OpcClient, OpcNodeId, SafeOpcFileHandle, byte[], OpcCallMethodOptions)static	Writes the data to the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The file node does not exist.
OpcException	The call of the method node failed (see exception details for more information).

SecureWrite(SafeOpcFileHandle, byte[])

static

Writes the data to the file identified by the fileHandle specified.

public static void SecureWrite(SafeOpcFileHandle fileHandle, byte[] data)

Public Shared Sub SecureWrite(fileHandle As SafeOpcFileHandle, data As Byte())

Parameters

Name	Type	Description
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
data	Byte[]	The data to write to the file at the current position.

Exceptions

Exception	Condition
ArgumentNullException	The fileHandle is a null reference (Nothing in Visual Basic).
NotSupportedException	The 'Write' method node does not exist or the method node signature does not define a valid method node to write data to a file.

Remarks

It is server-dependent whether the written data is persistently stored if the session is ended without calling the Close method.

SecureWrite(SafeOpcFileHandle, byte[], OpcCallMethodOptions)

static

Writes the data to the file identified by the fileHandle specified.

public static void SecureWrite(
    SafeOpcFileHandle fileHandle,
    byte[] data,
    OpcCallMethodOptions options)

Public Shared Sub SecureWrite(
    fileHandle As SafeOpcFileHandle,
    data As Byte(),
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
data	Byte[]	The data to write to the file at the current position.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to write data to a file.

Exceptions

Exception	Condition
ArgumentNullException	The fileHandle or data is a null reference (Nothing in Visual Basic).
NotSupportedException

Remarks

It is server-dependent whether the written data is persistently stored if the session is ended without calling the Close method.

SecureWrite(OpcFileNodeContext, SafeOpcFileHandle, byte[])

static

Writes the data to the file maintained by the file node referenced by the context specified.

public static void SecureWrite(
    OpcFileNodeContext context,
    SafeOpcFileHandle fileHandle,
    byte[] data)

Public Shared Sub SecureWrite(
    context As OpcFileNodeContext,
    fileHandle As SafeOpcFileHandle,
    data As Byte())

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
data	Byte[]	The data to write to the file at the current position.

Exceptions

Exception	Condition
ArgumentNullException	The context, fileHandle or data is a null reference (Nothing in Visual Basic).
NotSupportedException	The 'Write' method node does not exist or the method node signature does not define a valid method node to write data to a file.

Remarks

It is server-dependent whether the written data is persistently stored if the session is ended without calling the Close method.

SecureWrite(OpcFileNodeContext, SafeOpcFileHandle, byte[], OpcCallMethodOptions)

static

Writes the data to the file maintained by the file node referenced by the context specified.

public static void SecureWrite(
    OpcFileNodeContext context,
    SafeOpcFileHandle fileHandle,
    byte[] data,
    OpcCallMethodOptions options)

Public Shared Sub SecureWrite(
    context As OpcFileNodeContext,
    fileHandle As SafeOpcFileHandle,
    data As Byte(),
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
data	Byte[]	The data to write to the file at the current position.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to write data to a file.

Exceptions

Exception	Condition
ArgumentNullException	The context, fileHandle or data is a null reference (Nothing in Visual Basic).
NotSupportedException	The 'Write' method node does not exist or the method node signature does not define a valid method node to write data to a file.

Remarks

It is server-dependent whether the written data is persistently stored if the session is ended without calling the Close method.

SecureWrite(OpcClient, OpcNodeId, SafeOpcFileHandle, byte[])

static

Writes the data to the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

public static void SecureWrite(
    OpcClient client,
    OpcNodeId fileNodeId,
    SafeOpcFileHandle fileHandle,
    byte[] data)

Public Shared Sub SecureWrite(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As SafeOpcFileHandle,
    data As Byte())

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Write' method node is to be called.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
data	Byte[]	The data to write to the file at the current position.

Exceptions

Exception	Condition
ArgumentNullException	The client, fileNodeId, fileHandle or data is a null reference (Nothing in Visual Basic).
NotSupportedException	The 'Write' method node does not exist or the method node signature does not define a valid method node to write data to a file.

Remarks

It is server-dependent whether the written data is persistently stored if the session is ended without calling the Close method.

SecureWrite(OpcClient, OpcNodeId, SafeOpcFileHandle, byte[], OpcCallMethodOptions)

static

Writes the data to the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

public static void SecureWrite(
    OpcClient client,
    OpcNodeId fileNodeId,
    SafeOpcFileHandle fileHandle,
    byte[] data,
    OpcCallMethodOptions options)

Public Shared Sub SecureWrite(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As SafeOpcFileHandle,
    data As Byte(),
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Write' method node is to be called.
fileHandle	SafeOpcFileHandle	The SafeOpcFileHandle acquired by one of the SecureOpen methods.
data	Byte[]	The data to write to the file at the current position.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to write data to a file.

Exceptions

Exception	Condition
ArgumentNullException	The client, fileNodeId, fileHandle or data is a null reference (Nothing in Visual Basic).
NotSupportedException	The 'Write' method node does not exist or the method node signature does not define a valid method node to write data to a file.

Remarks

It is server-dependent whether the written data is persistently stored if the session is ended without calling the Close method.

SetPosition

static · 4 overloads

Overload	Description
SetPosition(OpcFileNodeContext, uint, ulong)static	Updates the position in the file maintained by the file node referenced by the context specified using position.
SetPosition(OpcFileNodeContext, uint, ulong, OpcCallMethodOptions)static	Updates the position in the file maintained by the file node referenced by the context specified using position.
SetPosition(OpcClient, OpcNodeId, uint, ulong)static	Updates the position in the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient using position.
SetPosition(OpcClient, OpcNodeId, uint, ulong, OpcCallMethodOptions)static	Updates the position in the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient using position.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The file node does not exist.
NotSupportedException	The 'SetPosition' method node does not exist or the method node signature does not define a valid method node to update the position in a file.
OpcException	The call of the method node failed (see exception details for more information).

SetPosition(OpcFileNodeContext, uint, ulong)

static

Updates the position in the file maintained by the file node referenced by the context specified using position.

[CLSCompliant(false)]
public static void SetPosition(
    OpcFileNodeContext context,
    uint fileHandle,
    ulong position)

<CLSCompliant(False)>
Public Shared Sub SetPosition(
    context As OpcFileNodeContext,
    fileHandle As UInteger,
    position As ULong)

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
position	UInt64	The new position in the file. If position is greater than the file size the position is set to the end of the file.

Exceptions

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

SetPosition(OpcFileNodeContext, uint, ulong, OpcCallMethodOptions)

static

Updates the position in the file maintained by the file node referenced by the context specified using position.

[CLSCompliant(false)]
public static void SetPosition(
    OpcFileNodeContext context,
    uint fileHandle,
    ulong position,
    OpcCallMethodOptions options)

<CLSCompliant(False)>
Public Shared Sub SetPosition(
    context As OpcFileNodeContext,
    fileHandle As UInteger,
    position As ULong,
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
position	UInt64	The new position in the file. If position is greater than the file size the position is set to the end of the file.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to update the position in a file.

Exceptions

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

SetPosition(OpcClient, OpcNodeId, uint, ulong)

static

Updates the position in the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient using position.

[CLSCompliant(false)]
public static void SetPosition(
    OpcClient client,
    OpcNodeId fileNodeId,
    uint fileHandle,
    ulong position)

<CLSCompliant(False)>
Public Shared Sub SetPosition(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As UInteger,
    position As ULong)

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'SetPosition' method node is to be called.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
position	UInt64	The new position in the file. If position is greater than the file size the position is set to the end of the file.

Exceptions

Exception	Condition
ArgumentNullException	The client or fileNodeId is a null reference (Nothing in Visual Basic).

SetPosition(OpcClient, OpcNodeId, uint, ulong, OpcCallMethodOptions)

static

Updates the position in the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient using position.

[CLSCompliant(false)]
public static void SetPosition(
    OpcClient client,
    OpcNodeId fileNodeId,
    uint fileHandle,
    ulong position,
    OpcCallMethodOptions options)

<CLSCompliant(False)>
Public Shared Sub SetPosition(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As UInteger,
    position As ULong,
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'SetPosition' method node is to be called.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
position	UInt64	The new position in the file. If position is greater than the file size the position is set to the end of the file.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to update the position in a file.

Exceptions

Exception	Condition
ArgumentNullException	The client or fileNodeId is a null reference (Nothing in Visual Basic).

Write

static · 4 overloads

Overload	Description
Write(OpcFileNodeContext, uint, byte[])static	Writes the data to the file maintained by the file node referenced by the context specified.
Write(OpcFileNodeContext, uint, byte[], OpcCallMethodOptions)static	Writes the data to the file maintained by the file node referenced by the context specified.
Write(OpcClient, OpcNodeId, uint, byte[])static	Writes the data to the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.
Write(OpcClient, OpcNodeId, uint, byte[], OpcCallMethodOptions)static	Writes the data to the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The file node does not exist.
NotSupportedException	The 'Write' method node does not exist or the method node signature does not define a valid method node to write data to a file.
OpcException	The call of the method node failed (see exception details for more information).

Write(OpcFileNodeContext, uint, byte[])

static

Writes the data to the file maintained by the file node referenced by the context specified.

[CLSCompliant(false)]
public static void Write(
    OpcFileNodeContext context,
    uint fileHandle,
    byte[] data)

<CLSCompliant(False)>
Public Shared Sub Write(
    context As OpcFileNodeContext,
    fileHandle As UInteger,
    data As Byte())

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
data	Byte[]	The data to write to the file at the current position.

Exceptions

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

Remarks

It is server-dependent whether the written data is persistently stored if the session is ended without calling the Close method.

Write(OpcFileNodeContext, uint, byte[], OpcCallMethodOptions)

static

Writes the data to the file maintained by the file node referenced by the context specified.

[CLSCompliant(false)]
public static void Write(
    OpcFileNodeContext context,
    uint fileHandle,
    byte[] data,
    OpcCallMethodOptions options)

<CLSCompliant(False)>
Public Shared Sub Write(
    context As OpcFileNodeContext,
    fileHandle As UInteger,
    data As Byte(),
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
context	OpcFileNodeContext	The OpcFileNodeContext to use to access the file node.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
data	Byte[]	The data to write to the file at the current position.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to write data to a file.

Exceptions

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

Remarks

It is server-dependent whether the written data is persistently stored if the session is ended without calling the Close method.

Write(OpcClient, OpcNodeId, uint, byte[])

static

Writes the data to the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

[CLSCompliant(false)]
public static void Write(
    OpcClient client,
    OpcNodeId fileNodeId,
    uint fileHandle,
    byte[] data)

<CLSCompliant(False)>
Public Shared Sub Write(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As UInteger,
    data As Byte())

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Write' method node is to be called.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
data	Byte[]	The data to write to the file at the current position.

Exceptions

Exception	Condition
ArgumentNullException	The client, fileNodeId or data is a null reference (Nothing in Visual Basic).

Remarks

It is server-dependent whether the written data is persistently stored if the session is ended without calling the Close method.

Write(OpcClient, OpcNodeId, uint, byte[], OpcCallMethodOptions)

static

Writes the data to the file maintained by the file node referenced by the fileNodeId specified using the further specified OpcClient.

[CLSCompliant(false)]
public static void Write(
    OpcClient client,
    OpcNodeId fileNodeId,
    uint fileHandle,
    byte[] data,
    OpcCallMethodOptions options)

<CLSCompliant(False)>
Public Shared Sub Write(
    client As OpcClient,
    fileNodeId As OpcNodeId,
    fileHandle As UInteger,
    data As Byte(),
    options As OpcCallMethodOptions)

Parameters

Name	Type	Description
client	OpcClient	The OpcClient to use to call the method.
fileNodeId	OpcNodeId	The OpcNodeId of the file node its 'Write' method node is to be called.
fileHandle	UInt32	The numeric file handle acquired by one of the Open methods.
data	Byte[]	The data to write to the file at the current position.
options	OpcCallMethodOptions	The OpcCallMethodOptions to apply before and after calling the method node to write data to a file.

Exceptions

Exception	Condition
ArgumentNullException	The client, fileNodeId or data is a null reference (Nothing in Visual Basic).

Remarks

It is server-dependent whether the written data is persistently stored if the session is ended without calling the Close method.