<< Click to Display Table of Contents >> Navigation:  »No topics above this level« DbiForceRecordReread

C syntax

DBIResult DBIFN DbiForceRecordReread (hCursor, pRecBuf);

Delphi syntax

function DbiForceRecordReread (hCursor: hDBICur; pRecBuff: Pointer): DBIResult stdcall;

Description

DbiForceRecordReread rereads a single record from the server on demand. It refreshes one row only, rather than clearing the cache.

Parameters

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

pRecBuf                Type: pBYTE                (Output)
Location of record buffer.

Usage

Use DbiForceRecordReread as an alternative to using DbiForceReread, which allows users to refresh their cursor by re-executing the query on the server. DbiForceReread may be an expensive call because the complete contents of the local cache must be updated. Based on the optimistic record locking method, individual records (rows) may be reread from the server if a record lock is requested. However this is based on a number of factors, including record age (how long since the record has been retrieved from the server).

Using DbiForceRecordReread, a valid record is reread from the server, based on the index or record address. The refreshed record value will be placed in pRecBuf. The behavior is similar to DbiGetRecord with a lock, except an optimistic record lock is not obtained, and the record is always reread from the server. Keep in mind that the record is always reread using the current index (or record address), which must be unique.

Prerequisites

A table must be open.

Completion state

A valid record is reread from the server and the refreshed record value is placed in pRecBuf.

See also

DbiForceReread