Click or drag to resize

DbServer.CopyDelimited Method

Copy records to a delimited file.

Namespace:  VO
Assembly:  VORDDClasses (in VORDDClasses.dll) Version: 2.5
Syntax
 VIRTUAL METHOD CopyDelimited(
	oFSTarget AS USUAL,
	cDelimiter AS USUAL,
	aFieldList AS USUAL,
	cbForBlock AS USUAL,
	cbWhileBlock AS USUAL,
	uScope AS USUAL
) AS USUAL

Parameters

oFSTarget
Type: Usual
The file to which the records is copied.
cDelimiter
Type: Usual
The delimiter for fields within a delimited database file. If omitted, the default is NULL_STRING.
aFieldList
Type: Usual
An array of fields that are to be included in the records to be copied.  The default is all fields.
cbForBlock
Type: Usual
The condition evaluated for each record in the scope; if TRUE, the record is included in the processing.  It provides the same functionality as the FOR clause of record processing commands.
cbWhileBlock
Type: Usual
The condition evaluated for each record from the current record until the condition returns FALSE.  It provides the same functionality as the WHILE clause of record processing commands.
uScope
Type: Usual
The range of records to process, providing the same functionality as the ALL, REST and NEXT clauses of record processing commands. Value Description DBSCOPEALL The scope is all the records in the table.  This is the default, although if a WHILE condition is specified, the scope becomes DBSCOPEREST. DBSCOPEREST The scope is the remaining records in the table from the current position. <nRecords> The scope is the next <nRecords> records.

Return Value

Type: Usual
TRUE if successful; otherwise, FALSE.  Note that after a FALSE indication, records can still have been copied to the target: the operation can have failed halfway through because the disk had been filled or other problems.
Remarks
Sends a NotifyIntentToMove message before the operation.  Sends a NotifyRecordChange message upon completion.
See Also