IDirectory interface | QSYS API Reference Guide

Estimated reading time: 3 minutes

Defines the contract for managing a directory in the ASNA DataGate client.

Namespace: ASNA.DataGate.Client Assembly: ASNA.QSys.DataGate.Client.dll

Extends: IAdgObject, IComparable, IConnectionHandler, IDisposable

In DG implementations of IDirectory , instance members are not guaranteed to be thread safe.

Remarks

This interface provides properties and methods to manage a directory in the ASNA DataGate client. It includes properties to get the list of items in the directory, the remote path name of the directory, and the enumerator for the directory. It also provides methods to attach a remote directory, create a subdirectory, enumerate the items in the directory, repair the objects in the directory, and enumerate the items in the directory using specified file types.



Properties

Type Name Description
IEnumerable Enumerator Gets the enumerator for the directory.
ArrayList ItemList Gets the list of items in the directory. This property is obsolete, use ‘Items’ instead.
List<IAdgObject> Items Gets the list of items in the directory.
String RemotePathName Gets the remote path name of the directory.

Methods

Signature Description
AttachRemoteDirectory(String) Attaches a remote directory to the current directory.
CreateSubDirectory(String) Creates a subdirectory in the current directory.
Enumerate(AdgEnumerator) Enumerates the items in the directory using the specified enumerator.
Enumerate(AdgEnumerator, FileTypes, Boolean) Enumerates the items in the directory using the specified enumerator and file types.
RepairObjects(RepairOptions, AdgObserver) Repairs the objects in the directory using the specified repair options and observer.

void AttachRemoteDirectory(string remotePathName)

Attaches a remote directory to the current directory.

void AttachRemoteDirectory(string remotePathName)

Parameters

Type Parameter name Description
String remotePathName The path name of the remote directory to attach.

IDirectory CreateSubDirectory(string Name)

Creates a subdirectory in the current directory.

IDirectory CreateSubDirectory(string Name)

Parameters

Type Parameter name Description
String Name The name of the subdirectory to create.

Returns

Type Description
IDirectory The created subdirectory.

void Enumerate(AdgEnumerator enumerator)

Enumerates the items in the directory using the specified enumerator.

void Enumerate(AdgEnumerator enumerator)

Parameters

Type Parameter name Description
AdgEnumerator enumerator The enumerator to use.

void Enumerate(AdgEnumerator enumerator, FileTypes fType, bool sysObjs)

Enumerates the items in the directory using the specified enumerator and file types.

void Enumerate(AdgEnumerator enumerator, FileTypes fType, bool sysObjs)

Parameters

Type Parameter name Description
AdgEnumerator enumerator The enumerator to use.
FileTypes fType The file types to enumerate.
Boolean sysObjs Whether to include system objects in the enumeration.

void RepairObjects(RepairOptions repairOptions, AdgObserver observer)

Repairs the objects in the directory using the specified repair options and observer.

void RepairObjects(RepairOptions repairOptions, AdgObserver observer)

Parameters

Type Parameter name Description
RepairOptions repairOptions The repair options to use.
AdgObserver observer The observer to use.