UnifiedAutomation.UaServer.IFileMethods Interface Reference

The interface for methods implemented on the FileModel object. More...

Inherited by UnifiedAutomation.UaServer.FileModel, UnifiedAutomation.UaServer.IAddressSpaceFileMethods, UnifiedAutomation.UaServer.IPubSubConfigurationMethods, and UnifiedAutomation.UaServer.ITrustListMethods.

Public Member Functions
StatusCode	Close (RequestContext context, FileModel model, uint FileHandle)
	Closes a file represented by a UnifiedAutomation.UaServer.FileModel. More...
StatusCode	GetPosition (RequestContext context, FileModel model, uint FileHandle, out ulong Position)
	Provides the current position of the FileHandle. More...
StatusCode	Open (RequestContext context, FileModel model, byte Mode, out uint FileHandle)
	Opens a file represented by an object of UnifiedAutomation.UaServer.FileModel. More...
StatusCode	Read (RequestContext context, FileModel model, uint FileHandle, int Length, out byte[] Data)
	Reads a part of the file starting from the current file position. More...
StatusCode	SetPosition (RequestContext context, FileModel model, uint FileHandle, ulong Position)
	Sets the current position of the FileHandle. More...
StatusCode	Write (RequestContext context, FileModel model, uint FileHandle, byte[] Data)
	Writes a part of the file starting from the current file position. More...

Detailed Description

The interface for methods implemented on the FileModel object.

Member Function Documentation

StatusCode UnifiedAutomation.UaServer.IFileMethods.Close	(	RequestContext	context,
		FileModel	model,
		uint	FileHandle
	)

Closes a file represented by a UnifiedAutomation.UaServer.FileModel.

When a client closes a file, the handle becomes invalid.

Parameters

context
model
FileHandle

Returns

Implemented in UnifiedAutomation.UaServer.FileModel.

StatusCode UnifiedAutomation.UaServer.IFileMethods.GetPosition	(	RequestContext	context,
		FileModel	model,
		uint	FileHandle,
		out ulong	Position
	)

Provides the current position of the FileHandle.

Parameters

context
model
FileHandle
Position	out:

Returns

Implemented in UnifiedAutomation.UaServer.FileModel.

StatusCode UnifiedAutomation.UaServer.IFileMethods.Open	(	RequestContext	context,
		FileModel	model,
		byte	Mode,
		out uint	FileHandle
	)

Opens a file represented by an object of UnifiedAutomation.UaServer.FileModel.

When a client opens a file, it gets a FileHandle that is valid while the session is open. Clients shall use the UnifiedAutomation.UaServer.IFileMethods.Close method to release the handle when they do not need access to the file anymore. Clients can open the same file several times for reading. A request to open for writing shall return Bad_NotWritable when the file is already opened.

Parameters

context
model
Mode
FileHandle	out:

Returns

Implemented in UnifiedAutomation.UaServer.TrustListModel, and UnifiedAutomation.UaServer.FileModel.

StatusCode UnifiedAutomation.UaServer.IFileMethods.Read	(	RequestContext	context,
		FileModel	model,
		uint	FileHandle,
		int	Length,
		out byte[]	Data
	)

Reads a part of the file starting from the current file position.

The file position is advanced by the number of bytes read.

Parameters

context
model
FileHandle
Length
Data	out:

Returns

Implemented in UnifiedAutomation.UaServer.FileModel.

StatusCode UnifiedAutomation.UaServer.IFileMethods.SetPosition	(	RequestContext	context,
		FileModel	model,
		uint	FileHandle,
		ulong	Position
	)

Sets the current position of the FileHandle.

Parameters

context
model
FileHandle
Position

Returns

Implemented in UnifiedAutomation.UaServer.FileModel.

StatusCode UnifiedAutomation.UaServer.IFileMethods.Write	(	RequestContext	context,
		FileModel	model,
		uint	FileHandle,
		byte[]	Data
	)

Writes a part of the file starting from the current file position.

The file position is advanced by the number of bytes written

Parameters

context
model
FileHandle
Data

Returns

Implemented in UnifiedAutomation.UaServer.FileModel.

---

The documentation for this interface was generated from the following file:

• D:/work/uasdknet_v3.2/src/UaServer/Models/UaBaseClasses.cs