IFileObject interface
Estimated reading time: 3 minutes
Defines the contract for managing a file in the ASNA DataGate client.
Namespace: ASNA.DataGate.Client Assembly: ASNA.QSys.DataGate.Client.dll
Extends: IAdgObject, IComparable, IConnectionHandler, IDisposable
In DG implementations of IFileObject , instance members are not guaranteed to be thread safe.
Remarks
This interface provides properties and methods to manage a file in the ASNA DataGate client. It includes properties to get the number of members in the file, the members of the file, the XML documents that define the file and its creation attributes, and various other properties related to the file. It also provides methods to copy the file, copy data from the file to a new file or from an import file to the file, read and write the definition and creation attributes of the file, get the AdgDataSet of the file, inspect the file, and repair the file.
Properties
| Type | Name | Description |
|---|---|---|
| XmlDocument | CreationAttributes | Gets or sets the XML document that defines the creation attributes of the file. |
| XmlDocument | Definition | Gets or sets the XML document that defines the file. |
| Int32 | FileWaitTime | Gets the file wait time in milliseconds. |
| IReadOnlyDictionary<String, String> | FormatIdentifiers | Provides access to the file’s format names and format identifiers. |
| Hashtable | FormatIDs | Gets the format IDs of the file. This property is obsolete, use ‘FormatIdentifiers’ instead. |
| Boolean | HasKeys | Gets a value indicating whether the file has keys. |
| Int32 | MemberCount | Gets the number of members in the file. |
| IEnumerable<IMember> | MemberObjects | Gets the members of the file. |
| XmlDocument | PrintCreationAttributes | Gets or sets the XML document that defines the print creation attributes of the file. |
| Int32 | RecordLength | Gets the length of a record in the file. |
| Int32 | RecordWaitTime | Gets the record wait time in milliseconds. |
| IEnumerable<String> | ReferencedFields | Gets the fields referenced by the file. |
| String | ReferenceFieldsFilePath | Gets the file path of the referenced fields. |
| Boolean | ReuseDeleted | Gets a value indicating whether deleted records should be reused. |
| ShareTypes | ShareType | Gets the share type of the file. |
Methods
| Signature | Description |
|---|---|
| AsyncCopyFromImportFile(String, CopyFromImportFileOptions) | Asynchronously copies data from an import file to the file. |
| Copy(String, String) | Copies the file to a new location with a new name. |
| CopyData(String, String, String, String, CopyDataOptions, Int32, Int32, Int32) | Copies data from the file to a new file. If this object does not represent a physical file, returns null. |
| CopyFromImportFile(String, CopyFromImportFileOptions) | Copies data from an import file to the file. |
| GetAdgDataSet(DataSetOptions) | Gets the AdgDataSet of the file. |
| InspectFile(InspectFileParts, InspectFileOutput, Int32&, AdgObserver) | Inspects the file. |
| ReadCreationAttributes(XmlReader) | Reads the creation attributes of the file from an XML reader. |
| ReadDefinition(XmlReader) | Reads the definition of the file from an XML reader. |
| RepairFile(RepairOptions, AdgObserver) | Repairs the file. |
| WriteCreationAttributes(XmlWriter) | Writes the creation attributes of the file to an XML writer. |
| WriteDefinition(XmlWriter) | Writes the definition of the file to an XML writer. |