DbiGetLinkStatus

C syntax

DBIResult DBIFN DbiGetLinkStatus (hCursor, phCursorMstr, phCursorDet, phCursorSib);

Delphi syntax

function DbiGetLinkStatus (hCursor: hDBICur; var hCursorMstr: hDBICur; var hCursorDet: hDBICur; var hCursorSib: hDBICur): DBIResult stdcall;

Description

DbiGetLinkStatus returns the master, detail, and sibling cursors, if any, of the specified linked cursor.

Parameters

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

phCursorMstr Type: phDBICur (Output)
Pointer to the master cursor, if any.

phCursorDet Type: phDBICur (Output)
Pointer to the first detail cursor, if any.

phCursorSib Type: phDBICur (Output)
Pointer to the next sibling detail cursor.

Usage

Used to find all links for the given cursor. If the cursor has a master, the master is returned. If the cursor has one or more details, the first detail is returned. If the cursor has siblings, the next sibling is returned. The master, detail, and sibling cursor handle can be used as an input to this function. If handle is not applicable, NULL is returned.

Prerequisites

The cursor must be a linked cursor. A linked cursor is created with DbiBeginLinkMode, DbiLinkDetail, or DbiLinkDetailToExp.

DbiResult	Meaning
DBIERR_NONE	The linked cursor status was returned successfully.
DBIERR_INVALIDHNDL	The specified handle is invalid, not a linked cursor, or NULL.