.NET Based OPC UA Client/Server SDK  2.6.0.418
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 Delete (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
DirectoryNameThe name of the directory to create. The name is used for the BrowseName and DisplayName of the directory object and also for the directory in the file system. For the BrowseName, the directoryName is used for the name part of the QualifiedName. The namespace index is Server specific. For the DisplayName, the directoryName is used for the text part of the LocalizedText. The locale part is Server specific.
DirectoryNodeIdThe NodeId of the created directory object.
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
FileNameThe name of the file to create. The name is used for the BrowseName and DisplayName of the file object and also for the file in the file system. For the BrowseName, the FileName is used for the name part of the QualifiedName. The namespace index is Server specific. For the DisplayName, the FileName is used for the text part of the LocalizedText. The locale part is Server specific.
RequestFileOpenFlag indicating whether the new file should be opened with the Write and Read bits set in the open mode after the creation of the file. If the flag is set to True, the file is created and opened for writing. If the flag is set to False, the file is just created.
FileNodeIdThe NodeId of the created file object.
FileHandleThe FileHandle is returned if RequestFileOpen is set to True. The FileNodeId and the FileHandle can be used to access the new file through the UnifiedAutomation.UaServer.FileModel object representing the new file. If RequestFileOpen is set to False, the returned value shall be 0 and shall be ignored by the caller.
Returns

Implemented in UnifiedAutomation.UaServer.FileDirectoryModel.

StatusCode UnifiedAutomation.UaServer.IFileDirectoryMethods.Delete ( 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
ObjectToDeleteThe NodeId of the file or directory to delete. In the case of a directory, all file and directory objects below the directory to delete are deleted recursively.
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
ObjectToMoveOrCopyThe NodeId of the file or directory to move or copy.
TargetDirectoryThe NodeId of the target directory of the move or copy command. If the file or directory is just renamed, the targetDirectory matches the ObjectId passed to the method call.
CreateCopyA flag indicating whether a copy of the file or directory should be created at the target directory.
NewNameThe new name of the file or directory in the new location. If the string is empty, the name is unchanged.
NewNodeIdThe NodeId of the moved or copied object. Even if the object is moved, the Server may return a new NodeId.
Returns

Implemented in UnifiedAutomation.UaServer.FileDirectoryModel.


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