Click or drag to resize

DbCopyDelim Function

X#
Export records to a new delimited text file.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.19
Syntax
 FUNCTION DbCopyDelim(
	cTargetFile,
	cDelim,
	acFields,
	cbForCondition,
	cbWhileCondition,
	nNext,
	nRecord,
	lRest,
	lNoOpt
) AS LOGIC CLIPPER
Request Example View Source

Parameters

cTargetFile (Optional)
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 .
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.
cDelim (Optional)
Type: Usual
The delimiter used to separate fields in cTargetFile.
The default delimiter is a double quote mark.
acFields (Optional)
Type: Usual
A list of fields to copy to cTargetFile.
The default is all fields.
cbForCondition (Optional)
Type: Usual
A code block that defines a condition that each record within the scope must meet in order to be processed.
cbWhileCondition (Optional)
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 (Optional)
Type: Usual
The number of records to process, starting at nRecord. Specify 0 to ignore this argument.
nRecord (Optional)
Type: Usual
A single record number to process. Specify 0 to ignore this argument.
lRest (Optional)
Type: Usual
TRUE processes only records from nStart to the end of the file. FALSE processes all records.
lNoOpt (Optional)
Type: Usual
Disable (Rushmore) optimizations (not supported yet).

Return Value

Type: Logic
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#
1USE Test NEW
2IF Used()
3    DBCopyDelim("newdelim")
4ENDIF
See Also