DbiBeginLinkMode

C syntax

DBIResult DBIFN DbiBeginLinkMode (phCursor);

Delphi syntax

function DbiBeginLinkMode (var hCursor: hDBICur): DBIResult stdcall;

Description

DbiBeginLinkMode converts a cursor to a link cursor. Given an open cursor, prepares for linked access. Returns a new cursor; the old cursor is no longer valid.

Parameters
phCursor	Type: phDBICur	(Input/Output)
On input, specifies the original cursor. On output, returns the new cursor; the old cursor is no longer valid.

Usage

Enables linking between tables using DbiLinkDetail. Both master and detail cursors must be link-enabled before calling DbiLinkDetail. DbiEndLinkMode must be called to end Link mode before the cursor is closed.

Warning:

Using the original cursor (supplied as input) will result in an error when used with any BDE calls.

DbiResult	Meaning
DBIERR_NONE	The cursor was successfully converted to a linked cursor.