.NET Based OPC UA Client/Server SDK  3.2.2.525
UnifiedAutomation.UaServer.IFileDirectoryMethods Interface Reference

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

Inherited by UnifiedAutomation.UaServer.FileDirectoryModel.

Public Member Functions

StatusCode CreateDirectory (RequestContext context, FileDirectoryModel model, string DirectoryName, out NodeId DirectoryNodeId)
 Creates a new FileDirectoryType object organized by this object. More...
 
StatusCode CreateFile (RequestContext context, FileDirectoryModel model, string FileName, bool RequestFileOpen, out NodeId FileNodeId, out uint FileHandle)
 Creates a new UnifiedAutomation.UaServer.FileModel object organized by this object. More...
 
StatusCode DeleteFileSystemObject (RequestContext context, FileDirectoryModel model, NodeId ObjectToDelete)
 Deletes a file or directory organized by this object. More...
 
StatusCode MoveOrCopy (RequestContext context, FileDirectoryModel model, NodeId ObjectToMoveOrCopy, NodeId TargetDirectory, bool CreateCopy, string NewName, out NodeId NewNodeId)
 Moves or copies a file or directory organized by this object to another directory or renames a file or directory. More...
 

Detailed Description

The interface for methods implemented on the FileDirectoryModel object.

Member Function Documentation

StatusCode UnifiedAutomation.UaServer.IFileDirectoryMethods.CreateDirectory ( RequestContext  context,
FileDirectoryModel  model,
string  DirectoryName,
out NodeId  DirectoryNodeId 
)

Creates a new FileDirectoryType object organized by this object.

Method Result Codes

Result Code Description
Bad_BrowseNameDuplicated A directory with the name already exists.
Bad_UserAccessDenied The user does not have permission to perform the requested operation.
Parameters
context
model
DirectoryName
DirectoryNodeIdout:
Returns

Implemented in UnifiedAutomation.UaServer.FileDirectoryModel.

StatusCode UnifiedAutomation.UaServer.IFileDirectoryMethods.CreateFile ( RequestContext  context,
FileDirectoryModel  model,
string  FileName,
bool  RequestFileOpen,
out NodeId  FileNodeId,
out uint  FileHandle 
)

Creates a new UnifiedAutomation.UaServer.FileModel object organized by this object.

The created file can be written using the UnifiedAutomation.UaServer.IFileMethods.Write method of the UnifiedAutomation.UaServer.FileModel.

Method Result Codes

Result Code Description
Bad_BrowseNameDuplicated A file with the name already exists.
Bad_UserAccessDenied The user does not have permission to perform the requested operation.
Parameters
context
model
FileName
RequestFileOpen
FileNodeIdout:
FileHandleout:
Returns

Implemented in UnifiedAutomation.UaServer.FileDirectoryModel.

StatusCode UnifiedAutomation.UaServer.IFileDirectoryMethods.DeleteFileSystemObject ( RequestContext  context,
FileDirectoryModel  model,
NodeId  ObjectToDelete 
)

Deletes a file or directory organized by this object.

Method Result Codes

Result Code Description
Bad_NotFound A file or directory with the provided NodeId is not organized by this object.
Bad_InvalidState The file or directory is locked and thus cannot be deleted.
Bad_UserAccessDenied The user does not have permission to perform the requested operation.
Parameters
context
model
ObjectToDelete
Returns

Implemented in UnifiedAutomation.UaServer.FileDirectoryModel.

StatusCode UnifiedAutomation.UaServer.IFileDirectoryMethods.MoveOrCopy ( RequestContext  context,
FileDirectoryModel  model,
NodeId  ObjectToMoveOrCopy,
NodeId  TargetDirectory,
bool  CreateCopy,
string  NewName,
out NodeId  NewNodeId 
)

Moves or copies a file or directory organized by this object to another directory or renames a file or directory.

Method Result Codes

Result Code Description
Bad_BrowseNameDuplicated A file or directory with the name already exists.
Bad_NotFound A file or directory with the provided NodeId is not organized by this object.
Bad_InvalidState The file or directory is locked and thus cannot be moved or copied.
Bad_UserAccessDenied The user does not have permission to perform the requested operation.
Parameters
context
model
ObjectToMoveOrCopy
TargetDirectory
CreateCopy
NewName
NewNodeIdout:
Returns

Implemented in UnifiedAutomation.UaServer.FileDirectoryModel.


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