DbiSetToBegin

C syntax

DBIResult DBIFN DbiSetToBegin (hCursor);

Delphi syntax

function DbiSetToBegin (hCursor: hDBICur): DBIResult stdcall;

Description

DbiSetToBegin positions the cursor to the beginning of the result set.

Parameters

hCursor Type: hDBICur (Input)
Specifies the cursor handle.

Usage

This function is used to reposition the cursor to the beginning of the result set. DbiGetNextRecord or DbiGetRelativeRecord can then be called to position the cursor on the first valid record of the result set.

Completion state

The cursor is positioned on the crack before the first record. There is no current record after DbiSetToBegin completes. (DbiGetRecord returns DBIERR_BOF.)

DbiResult	Meaning
DBIERR_NONE	The cursor was successfully set to BOF.
DBIERR_INVALIDHNDL	The specified cursor handle is invalid or NULL.