DbFileSpec Class (Typed) |
Namespace: XSharp.VO.SDK
The DbFileSpec type exposes the following members.
Name | Description | |
---|---|---|
DbFileSpec(String, String, Array) |
Instantiates a DBFileSpec object and fills its instance variables with DBF information.
| |
DbFileSpec(FileSpec, String, Array) |
Instantiates a DBFileSpec object and fills its instance variables with DBF information.
|
Name | Description | |
---|---|---|
Attributes |
One or more of the following characters concatenated into a string, indicating the attributes of the file represented by this file specification:
(Inherited from FileSpec.) | |
DateChanged |
A date value denoting when the file was created or last changed. If the file is not found, NULL_DATE is returned.
(Inherited from FileSpec.) | |
DBFAttr |
The DBF file attributes returned as a string type.
| |
DBFDateChanged |
The DBF file date stamp returned as a date type.
| |
DBFName |
The DBF file name and extension.
| |
DBFSize |
The DBF file size.
| |
DBFTime |
The DBF file time stamp returned as a string.
| |
DbStruct |
Returns an array containing the structure of the DBF file.
| |
Delim |
Access the delimiter used for the CopyTo() method.
| |
Drive |
A string representing the drive defined to this file specification.
(Inherited from FileSpec.) | |
ErrInfo | Return the error object from the last Copy() or Move() operation. (Inherited from FileSpec.) | |
Extension |
A string representing the extension defined to this file specification.
(Inherited from FileSpec.) | |
FCount |
The number of fields in the DBF file.
| |
Fields |
The 1-D array of DBF fields to copy out to when using the CopyTo() method.
| |
FileName |
Assign a file name to the DBFileSpec object.
(Overrides FileName.) | |
ForBlock |
The FOR condition code block used for the CopyTo() method.
| |
FullPath |
Assign a full path—including drive, directory, file name, and extension—to the DBFileSpec object.
(Overrides FullPath.) | |
HeaderSize |
The size of the DBF file header.
| |
HidRDDs |
The 1-D array of "hidden" RDDs (i.e., DBFMEMO) used for the CopyTo() method.
| |
IndexNames |
The 1-D array of index files with drive, path, file name, and extension information.
| |
IsAnsi |
The ANSI/OEM setting used in the DBF file header.
| |
LastUpDate |
The date of the last update made to the DBF file as reported in the DBF header.
| |
MemAttr |
The memo file attributes.
| |
MemBlockSize |
The memo block size used in the memo file.
| |
MemDateChanged |
The memo file date stamp returned as a date type.
| |
MemFileExt |
The memo file name extension excluding the file name.
| |
MemFileName |
The base memo file name excluding the file name extension.
| |
MemFullPath |
The full path of the memo file, including drive, directory, file name, and extension.
| |
MemName |
The memo file name and extension.
| |
MemSize |
The memo file size.
| |
MemTime |
The memo file time stamp returned as a string.
| |
Orders |
The 1-D array of OrderSpec objects that are associated with this DBFileSpec object.
| |
Path |
A string representing the path defined to this file specification.
(Inherited from FileSpec.) | |
RDD_Name |
The name of the RDD used for instantiation.
| |
RDD_Version |
The version number of the RDD.
| |
RDDs |
An array of "hidden" RDDs (such as DBFMEMO) used for instantiation.
| |
RecCount |
The number of records in the DBF. (Note that "LastRec" is not available in this class, only in the dbServer class)
| |
RecNo |
The record number for the CopyTo() method when a single record is required.
| |
Records |
The number of records for the CopyTo() method.
| |
RecSize |
The record size of the DBF.
| |
Rest |
A logical determining if the CopyTo() method is to copy all records or the current record to EOF.
| |
RLockCount |
The number of locked records in the DBF.
| |
SDF |
A logical determining if the CopyTo() method is to copy out to an SDF file.
| |
Size |
A numeric value representing the size, in bytes, of the file represented by this file specification.
(Inherited from FileSpec.) | |
TimeChanged |
A string indicating the time when the file was created or last changed.
(Inherited from FileSpec.) | |
WhileBlock |
A WHILE condition code block used with the CopyTo() method.
|
Name | Description | |
---|---|---|
AppendToPath |
Append a subdirectory to the end of this file specification's path.
(Inherited from FileSpec.) | |
Copy(String, Logic) |
Make a copy of the file represented by this file specification.
(Inherited from FileSpec.) | |
Copy(FileSpec, Logic) |
Make a copy of the file represented by this file specification.
(Inherited from FileSpec.) | |
Copy(Usual, Usual, Usual) |
Copies all files associated with DBFileSpec objects to a different drive and/or directory.
| |
CopyTo |
Copies the DBFileSpec object's DBF file to another data format. This can be used for copying out to another RDD, to a delimited file, or to an SDF file.
| |
Create |
Create a new DBF file with the given name, using a provided DBStruct array.
| |
DBFSGetInfo |
Fills in the DBFileSpec object's instance variables. This method is not required when using the Find() method, which will invoke this method internally if the file is found.
| |
Delete |
Physically deletes all files that are associated with the DBFileSpec object, including memo files and any index files associated with the DBF through OrderSpec objects.
(Overrides Delete.) | |
Error(Error) |
Provide a method for handling error conditions raised during FileSpec processing. This is an event handler: it is automatically called by other methods; the developer does not normally need to call the error method, but might want to replace or amend it.
(Inherited from FileSpec.) | |
Error(Error, Symbol) |
Provide a method for handling error conditions raised during FileSpec processing. This is an event handler: it is automatically called by other methods; the developer does not normally need to call the error method, but might want to replace or amend it.
(Inherited from FileSpec.) | |
Find |
Locates the file defined in the DBFileSpec object using the current directory, SetDefault(), or SetPath(). Fills in the instance variables of the DBFileSpec if successful.
(Overrides Find.) | |
Move(String, Logic) |
Move the file represented by this file specification to a new location.
(Inherited from FileSpec.) | |
Move(FileSpec, Logic) |
Move the file represented by this file specification to a new location.
(Inherited from FileSpec.) | |
Move(Usual, Usual, Usual) |
Moves and/or renames all files associated with DBFileSpec objects to a different drive and/or directory. Updates DBFileSpec and/or OrderSpec instance variables. Will also rename auto-open index files. Only DBF, MEMO and auto-open index files will get renamed.
| |
PathUp |
Remove the last subdirectory from the end of this file specification's path.
(Inherited from FileSpec.) | |
Rename(String, Logic) |
Rename the file represented by this file specification.
(Inherited from FileSpec.) | |
Rename(Usual, Usual) |
Renames files associated with DBFileSpec object. Only DBF/MEMO and auto-open index files will get renamed.
Rename() will not rename a file if it is already open or there is a file name conflict.
To rename files to another directory, use the Move() method and supply a different target file name.
| |
Rename(FileSpec, Logic) |
Rename the file represented by this file specification.
(Inherited from FileSpec.) |
1oDBFileSpec := DBFileSpec{"c:\data\custdata.dbf"} 2IF oDBFileSpec:Find() // File exists? 3aDBStruct := oDBFileSpec:DBStruct 4oDBFileSpec:Drive := "d:" 5oDBFileSpec:Create(aDBStruct) 6ENDIF