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

C syntax

DBIResult DBIFN DbiOpenFamilyList (hDb, pszTableName, [pszDriverType], phFmlCur);

Delphi syntax

function DbiOpenFamilyList (hDb: hDBIDb; pszTableName: PChar; pszDriverType: PChar; var hFmlCur: hDBICur): DBIResult stdcall;

Description

DbiOpenFamilyList creates a table listing the family members associated with a specified table. Each of the family records can be retrieved by using DbiGetNextRecord. DbiGetCursorProps can be used to allocate the proper record size. After the record is retrieved, it can be cast with the FMLDesc type definition, and used like an FMLDesc C language structure.

Parameters

hDb                Type: hDBIDb                (Input)
Specifies the database handle.

pszTableName                Type: pCHAR                (Input)
Pointer to the table name. If pszTableName is a fully qualified name of a table, the pszTableType parameter need not be specified. If the path is not included, the path name is taken from the current directory of the database associated with hDb.

pszDriverType                Type: pCHAR                (Input)
Pointer to the table type. Optional. This parameter is required if pszTableName has no extension. pszDriverType can be one of the following values: szDBASE, szMSACCESS, or szPARADOX.

phFmlCur                Type: phDBICur                (Output)
Pointer to the family list table.

Usage

Family members include default members, as specified by the driver, and registered family members.

dBASE or FoxPro: For dBASE or FoxPro tables, the table can include maintained index files (.MDX files), compressed index files (.CDX files), BLOBs (.DBT or .FPT files), and tables (.DBF files).

Paradox: For Paradox tables, the table can include index files (.PX, .X??, .Y?? files), BLOBs (.MB files), and validity check and referential integrity files (.VAL files).

SQL, Access: This function is not supported with SQL and Access tables. With SQL and Access databases, this function returns an empty table.

Prerequisites

The user must have full password rights to the table; that is, any required passwords to get prvFULL rights must have been added to the current session prior to calling this function.

See also

DbiOpenFileList, DbiOpenFieldList, DbiOpenIndexList, DbiOpenRintList, DbiOpenSecurityList