Click or drag to resize

DbServer.Total Method

Aggregate records by key value, producing grouped summarizations, and write the aggregate records to another database.

Namespace:  VO
Assembly:  VORDDClasses (in VORDDClasses.dll) Version: 2.5
Syntax
 VIRTUAL METHOD Total(
	oFSTarget AS USUAL,
	cbKeyField 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 summary data is written.
cbKeyField
Type: Usual
The key field in this server that is the basis for the summarization.  Note that for the summarization to produce correct results, the table should be indexed or sorted on this key field.
aFieldList
Type: Usual
An array of the fields that are to be summarized.
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 of a scoped operation, some records can have been written to the target file: the operation can have failed halfway through because of lock conflicts or technical problems.
Remarks
Sends a NotifyIntentToMove message before the operation.  Sends a NotifyRecordChange message upon completion.
Examples
This method does not open the new file, it simply creates the file on disk.  If you want to open it afterwards, you simply instantiate it directly.
X#
1IF oDB1:Total(oFSTarget)
2oDB2 := DBServer{oFSTarget}
3ELSE
4...
5ENDIF
See Also