DbServer.Recall Method (Typed) | |
Recall those deleted records indicated by a specified scope.
Namespace:
XSharp.VO.SDK
Assembly:
XSharp.VORDDClasses (in XSharp.VORDDClasses.dll) Version: 2.19
Syntax VIRTUAL METHOD Recall(
cbForBlock AS USUAL,
cbWhileBlock AS USUAL,
uScope AS USUAL
) AS LOGIC
public virtual bool Recall(
[DefaultParameterValueAttribute(0, 1)] Usual cbForBlock,
[DefaultParameterValueAttribute(0, 1)] Usual cbWhileBlock,
[DefaultParameterValueAttribute(0, 1)] Usual uScope
)
Request Example
View SourceParameters
- 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 first 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:
Logic
TRUE if successful; otherwise, FALSE (although some records still might have been processed).
Remarks
If no scope was passed and no scope was active, it sends a NotifyRecordChange, if the operation was successful.
If a scope was used, it sends a NotifyFileChange message regardless of the number of records processed.
If no server scope is set, it recalls the current record. On successful completion, the current record will be the last file record and DBServer:EOF will be TRUE.
See Also