Click or drag to resize

DbCopyDelim Function

Export records to a new delimited text file.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.10
Syntax
 FUNCTION DbCopyDelim(
	 cTargetFile AS USUAL,
	 cDelim AS USUAL,
	 acFields AS USUAL,
	 cbForCondition AS USUAL,
	 cbWhileCondition AS USUAL,
	 nNext AS USUAL,
	 nRecord AS USUAL,
	 lRest AS USUAL,
	 aStruct AS USUAL
) AS LOGIC
View Source

Parameters

cTargetFile
Type: Usual
The name of the target file, including an optional drive, directory, and extension.  See SetDefault() and SetPath() for file searching and creation rules.  The default extension for database files is determined by the RDD (see the "RDD Specifics" appendix in the Programmer's Guide for details on a particular RDD).  For text files, it is .TXT.
If <cTargetFile> does not exist, it is created.  If it exists, this function attempts to open the file in exclusive mode and, if successful, the file is overwritten without warning or error.  If access is denied because, for example, another process is using the file, NetErr() is set to TRUE.  Refer to the "Concurrency Control" chapter in the Programmer's Guide for more information on resolving concurrency conflicts.
cDelim
Type: Usual
The delimiter used to separate fields in <cTargetFile>.  The default delimiter is a double quote mark.
acFields
Type: Usual
A list of fields to copy to <cTargetFile>.  The default is all fields.
cbForCondition
Type: Usual
A code block that defines a condition that each record within the scope must meet in order to be processed.
cbWhileCondition
Type: Usual
A code block that defines another condition that each record must meet in order to be processed.   As soon as a record is encountered that causes the condition to fail, the operation terminates.
If no scope is specified, <cbWhileCondition> changes the default scope to <lRest>.
You define the scope using one of these three, mutually exclusive arguments.  The default is all records.
nNext
Type: Usual
The number of records to append, starting at the current record.
nRecord
Type: Usual
The number of the record to append.
lRest
Type: Usual
TRUE processes only records from the current record to end-of-file.  FALSE processes all records.
aStruct
Type: Usual

Return Value

Type: Boolean
TRUE if successful; otherwise, FALSE.
Remarks
Tip Tip
The <nNext>, <nRecord>, and <lRest> arguments are mutually exclusive. You should not pass all three of them. And if you pass the <cbWhile> argument then this also controls the scope behavior.
DBCopyDelim() is the functional equivalent of the COPY TO DELIMITED command.   It is the same as DBCopy() except that it copies records to a delimited text file.  See COPY TO and DBCopy() for more information.
Examples
The following example copies records from the current database file to a delimited text file:
X#
USE Test NEW
IF Used()
        DBCopyDelim("newdelim")
ENDIF
See Also