.NET Based OPC UA Client/Server SDK  3.1.0.500
UnifiedAutomation.UaClient.FileDirectoryModel Class Reference

Used to access a File object on an OPC UA Server. More...

Inherits UnifiedAutomation.UaClient.SessionMethodHelper.

Public Member Functions

 FileDirectoryModel (ApplicationInstanceBase application)
 Initializes a new instance of the FileDirectoryModel class. More...
 
 FileDirectoryModel (Session session)
 Initializes a new instance of the FileDirectoryModel class. More...
 
NodeId CreateDirectory (NodeId parentId, string directoryName)
 Creates a new directory. More...
 
IAsyncResult BeginCreateDirectory (NodeId parentId, string directoryName, int timeout, AsyncCallback callback, object callbackData)
 Begins an operation to create a new directory. More...
 
NodeId EndCreateDirectory (IAsyncResult result)
 Completes an operation to CreateDirectory a file from the server. More...
 
NodeId CreateFile (NodeId parentId, string fileName)
 Creates a new file. More...
 
NodeId CreateFile (NodeId parentId, string fileName, bool openFile, int timeout, out uint fileHandle)
 Creates a new directory. More...
 
IAsyncResult BeginCreateFile (NodeId parentId, string fileName, bool openFile, int timeout, AsyncCallback callback, object callbackData)
 Begins an operation to create a new directory. More...
 
NodeId EndCreateFile (IAsyncResult result, out uint fileHandle)
 Completes an operation to CreateFile a file from the server. More...
 
void Delete (NodeId parentId, NodeId fileOrDirectoryId)
 Deletes a file or directory. More...
 
IAsyncResult BeginDelete (NodeId parentId, NodeId fileOrDirectoryId, int timeout, AsyncCallback callback, object callbackData)
 Begins an operation to create a new directory. More...
 
void EndDelete (IAsyncResult result)
 Completes an operation to delete a file or directory on the server. More...
 
NodeId MoveOrCopy (NodeId parentId, NodeId fileToMove, NodeId targetDirectory, string newName, bool createCopy)
 Moves or copies a file or directory on the server. More...
 
IAsyncResult BeginMoveOrCopy (NodeId parentId, NodeId fileToMove, NodeId targetDirectory, string newName, bool createCopy, int timeout, AsyncCallback callback, object callbackData)
 Begins an operation to create a new directory. More...
 
NodeId EndMoveOrCopy (IAsyncResult result)
 Completes an operation to MoveOrCopy a file from the server. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaClient.SessionMethodHelper
 SessionMethodHelper (ApplicationInstanceBase application)
 Initializes a new instance of the SessionMethodHelper class. More...
 
 SessionMethodHelper (Session session)
 Initializes a new instance of the SessionMethodHelper class. More...
 
void Dispose ()
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 
void Connect (int timeout)
 Connects to the server. More...
 
void BeginConnect (AsyncCallback callback, object callbackData)
 Connects to the server. More...
 
void Disconnect ()
 Disconnects from the server. More...
 

Additional Inherited Members

- Protected Member Functions inherited from UnifiedAutomation.UaClient.SessionMethodHelper
virtual void Dispose (bool disposing)
 Releases unmanaged and—optionally—managed resources. More...
 
UserIdentity RequestAdminCredentials ()
 Gets the admin credentials. More...
 
- Properties inherited from UnifiedAutomation.UaClient.SessionMethodHelper
string EndpointUrl [get, set]
 Gets or sets the endpoint URL. More...
 
Session Session [get]
 Gets the session. More...
 
RequestSettings DefaultRequestSettings [get, set]
 Gets or sets the default request settings. More...
 
int DefaultTimeout [get]
 Gets the default timeout. More...
 
UserIdentity AdminCredentials [get, set]
 Gets or sets the administrator credentials. More...
 
bool IsConnected [get]
 Gets a value indicating whether a connection to the server is active. More...
 
bool MustCloseSession [get]
 A flag indicating that the object created the session and therefore must close it. More...
 
- Events inherited from UnifiedAutomation.UaClient.SessionMethodHelper
EventHandler ServerStatusChanged
 Occurs when the server status changes. More...
 
EventHandler
< CredentialsRequiredEventArgs
AdminCredentialsRequired
 Raised when admin credentials are required. More...
 

Detailed Description

Used to access a File object on an OPC UA Server.

Constructor & Destructor Documentation

UnifiedAutomation.UaClient.FileDirectoryModel.FileDirectoryModel ( ApplicationInstanceBase  application)
inline

Initializes a new instance of the FileDirectoryModel class.

Parameters
applicationThe application to use.
UnifiedAutomation.UaClient.FileDirectoryModel.FileDirectoryModel ( Session  session)
inline

Initializes a new instance of the FileDirectoryModel class.

Parameters
sessionThe session to use.

Member Function Documentation

IAsyncResult UnifiedAutomation.UaClient.FileDirectoryModel.BeginCreateDirectory ( NodeId  parentId,
string  directoryName,
int  timeout,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to create a new directory.

Parameters
parentIdThe identifier for the parent directory.
directoryNameName of the new directory.
timeoutThe timeout in milliseconds. Specify 0 to use the default timeout.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asynchronous operation.
IAsyncResult UnifiedAutomation.UaClient.FileDirectoryModel.BeginCreateFile ( NodeId  parentId,
string  fileName,
bool  openFile,
int  timeout,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to create a new directory.

Parameters
parentIdThe identifier for the parent directory.
fileNameName of the new file.
openFileIf TRUE the file is opened after it is created.
timeoutThe timeout in milliseconds. Specify 0 to use the default timeout.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asynchronous operation.
IAsyncResult UnifiedAutomation.UaClient.FileDirectoryModel.BeginDelete ( NodeId  parentId,
NodeId  fileOrDirectoryId,
int  timeout,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to create a new directory.

Parameters
parentIdThe identifier for the parent directory.
fileOrDirectoryIdThe file or directory identifier.
timeoutThe timeout in milliseconds. Specify 0 to use the default timeout.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asynchronous operation.
IAsyncResult UnifiedAutomation.UaClient.FileDirectoryModel.BeginMoveOrCopy ( NodeId  parentId,
NodeId  fileToMove,
NodeId  targetDirectory,
string  newName,
bool  createCopy,
int  timeout,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to create a new directory.

Parameters
parentIdThe identifier for the parent directory.
fileToMoveThe file to move.
targetDirectoryThe target directory.
newNameThe new name.
createCopyif set to true a copy is created.
timeoutThe timeout in milliseconds. Specify 0 to use the default timeout.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asynchronous operation.
NodeId UnifiedAutomation.UaClient.FileDirectoryModel.CreateDirectory ( NodeId  parentId,
string  directoryName 
)
inline

Creates a new directory.

Parameters
parentIdThe identifier for the parent directory.
directoryNameName of the new directory.
Returns
The NodeId for the new directory object.
NodeId UnifiedAutomation.UaClient.FileDirectoryModel.CreateFile ( NodeId  parentId,
string  fileName 
)
inline

Creates a new file.

Parameters
parentIdThe identifier for the parent directory.
fileNameName of the new file.
Returns
The NodeId for the new file object.
NodeId UnifiedAutomation.UaClient.FileDirectoryModel.CreateFile ( NodeId  parentId,
string  fileName,
bool  openFile,
int  timeout,
out uint  fileHandle 
)
inline

Creates a new directory.

Parameters
parentIdThe identifier for the parent directory.
fileNameName of the new file.
openFileIf TRUE the file is opened after it is created.
timeoutThe timeout in milliseconds. Specify 0 to use the default timeout.
fileHandleThe file for the file if it was opened.
Returns
The NodeId for the new directory object.
void UnifiedAutomation.UaClient.FileDirectoryModel.Delete ( NodeId  parentId,
NodeId  fileOrDirectoryId 
)
inline

Deletes a file or directory.

Parameters
parentIdThe identifier for the parent directory.
fileOrDirectoryIdThe file or directory identifier.
NodeId UnifiedAutomation.UaClient.FileDirectoryModel.EndCreateDirectory ( IAsyncResult  result)
inline

Completes an operation to CreateDirectory a file from the server.

Parameters
resultThe object used to manage the state of the asynchronous operation.
Returns
The NodeId for the new directory object.
NodeId UnifiedAutomation.UaClient.FileDirectoryModel.EndCreateFile ( IAsyncResult  result,
out uint  fileHandle 
)
inline

Completes an operation to CreateFile a file from the server.

Parameters
resultThe object used to manage the state of the asynchronous operation.
fileHandleThe file for the file if it was opened.
Returns
The NodeId for the new directory object.
void UnifiedAutomation.UaClient.FileDirectoryModel.EndDelete ( IAsyncResult  result)
inline

Completes an operation to delete a file or directory on the server.

Parameters
resultThe object used to manage the state of the asynchronous operation.
NodeId UnifiedAutomation.UaClient.FileDirectoryModel.EndMoveOrCopy ( IAsyncResult  result)
inline

Completes an operation to MoveOrCopy a file from the server.

Parameters
resultThe object used to manage the state of the asynchronous operation.
Returns
The NodeId for the new file or directory object.
NodeId UnifiedAutomation.UaClient.FileDirectoryModel.MoveOrCopy ( NodeId  parentId,
NodeId  fileToMove,
NodeId  targetDirectory,
string  newName,
bool  createCopy 
)
inline

Moves or copies a file or directory on the server.

Parameters
parentIdThe identifier for the parent directory.
fileToMoveThe file to move.
targetDirectoryThe target directory.
newNameThe new name.
createCopyif set to true a copy is created.
Returns
The NodeId for the new file or directory object.

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