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

C syntax

DBIResult DBIFN DbiOpenFileList (hDb, [pszWild], phCur);

Delphi syntax

function DbiOpenFileList (hDb: hDBIDb; pszWild: PChar; var hCur: hDBICur): DBIResult stdcall;

Description

DbiOpenFileList opens a cursor on a list of files contained within the database.

Parameters

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

pszWild                Type: pCHAR                (Input)
Pointer to the search string for retrieving a selective list of tables. Two wildcard characters can be used: the asterisk (*) and the question mark (?). The asterisk expands to any number of characters; the question mark expands to a single character.

phCur                Type: phDBICur                (Output)
Pointer to the file list table.

Usage

Each of the file 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 FILEDesc type definition, and used like an FILEDesc C language structure.

Access: This function is not supported.

Standard: DbiOpenFileList provides an efficient way to retrieve all the names of files in a database directory. This function returns a list of all files that match the wildcard criteria, if any.

SQL: This function returns information similar to that returned by DbiOpenTableList. Some fields, such as szExt, bDir, and iSize, are not applicable for SQL databases.

Synonyms: Many server vendors (including Oracle) provide objects called synonyms. Synonyms are alternate names for other objects, such as tables or views. SQL Links provides the option to include synonyms in the table lists returned from DbiOpenTableList and DbiOpenFileList. See SQL Links Guide).

 

See also

DbiOpenDatabase, DbiOpenTableList