Dbi Exit

No parameters

Part III—The We/I-Rounded Application

RETURNS: DBIResult

Part III—The We/I-Rounded Application

RETURNS: DBIResult

DbiExit disconnects the application from BDE. It releases all resources allocated by the client application and should be the last DBI/BDE call made by the client application.

DbiExtractKey ( hCursor, pRecBuf, pKeyBuf)

hCursor pRecBuf hDBICur Byte pKeyBuf Byte

RETURNS: DBIResult

The cursor handle.

Pointer to the record buffer that contains the key to be extracted.

The variable to receive the key value.

The function DbiExtractKey gets the key value for the current record from either the cursor or the record buffer.

DbiForceRecordReread ( hCursor, pRecBuf)

hCursor pRecBuf hDBICur

Byte

The cursor handle. Pointer to the record buffer.

RETURNS: DBIResult

DbiForceRecordReread reads a single record from the server and refreshes a single row only. This does not re-execute the query.

DbiForceReread ( hCursor)

hCursor hDBICur The cursor handle.

RETURNS: DBIResult

The function DbiForceReread refreshes all data for the cursor. The refreshed data will include any remotely updated rows.

DbiFormFullName ( hDb, szTableName, szDriverType, szFullName )

hDb szTableName szDriverType szFullName hDBIDb

PChar PChar PChar

The database handle.

The table name.

The name of the driver type.

The variable that will receive the fully qualified table name.

RETURNS: DBIResult

Appendix A-BDE API Quick Reference ■ 3 17

DbiFormFullName supplies a fully qualified filename based on the settings for the working directory known to the BDE.

DbiFreeBlob ( hCursor, pRecBuf, ¡Field )

hCursor pRecBuf

¡Field hDBICur Byte

UINTI 6

The cursor handle.

Pointer to the record buffer that contains the BLOB handle.

The subscript that indicates the position of the BLOB field.

RETURNS: DBIResult

DbiFreeBlob releases a BLOB handle that was opened through a call to DbiOpenBlob.

DbiGetBlob ( hCursor; pRecBuf, iField, iOfßet, iLen, pDest, iRead )

hCursor pRecBuf

¡Field iOffSet iLen pDest ¡Read hDBICur

Byte

UINTI6

UINT32 UINT32 Byte pUINT32

The cursor handle.

Pointer to the record buffer containing the BLOB handle.

The subscript that indicates the position of the BLOB field.

The starting location for retrieval within the BLOB field.

The number of bytes of the BLOB field to retrieve.

The variable that will receive the BLOB data. The variable that receives the count of the number of bytes read.

RETURNS: DBIResult

The function DbiGetBlob retrieves the BLOB data from the field specified. This function is used with Paradox tables only and is needed to support the feature of storing a minimal amount of BLOB data in the itself.

DbiGetBlobHeading ( Kursor, ¡Field, pRecBuf, pDest )

hCursor ¡Field pRecBuf hDBICur

UINTI6

Byte

The cursor handle.

The subscript that Indicates the position of the BLOB field.

Pointer to the record buffer.

3 18

Part III—The Well-Rounded Application pDest

Byte

The variable that will receive the BLOB heading.

RETURNS: DBIResult

DbiGetBlobHeading provides information about the specified BLOB field in the record buffer.

DbiGetBlobSize ( hCursor, pRecBuf, ¡Field, piSize )

hCursor pRecBuf ¡Field hDBICur

Byte

UINTI6

piSize pUINT32

RETURNS: DBIResult

The cursor handle.

Pointer to the record buffer.

The subscript that indicates the position of the BLOB field.

The variable that will receive the BLOB size retrieves the size, in bytes, of the specified BLOB data from the record buffer.

DbiGetBookMark ( hCur, pBookMark)

hCur pBookMark hDBICur

Byte

The cursor handle.

Pointer to the bookmark buffer.

RETURNS : DBIResult

The function DbiGetBookMark saves the current row position in the provided cursor to the pBookMark buffer defined by the application.

DbiGetCallBack ( hCursor, ecbType, piClientData, piCbBufLen, ppCbBuf, ppfCb )

hCursor ecbType piClientData piCbBufLen ppCbBuf ppfCb hDBICur

CBType pUINT32

pUINT I6

ppVOID

ppfDBICallBack

The cursor handle.

The type of callback.

Pointer to the passthrough client data.

The callback buffer length.

The callback buffer pointer.

The variable that receives the pointer to the callback function.

RETURNS : DBIResult

3 18

Appendix A—BDE API Quick Reference ■ 3 19

The function DbiGetCallBack is usually used to determine if a specified callback function was previously registered for the cursor. It retrieves a pointer to the callback function if it was registered, NIL if it was not.

DbiGetClientlnfo ( pClientlnfo )

pClientlnfo pCLIENTInfo

RETURNS : DBIResult

Pointer to a structure of type CLIENTInfo.

DbiGetClientlnfo retrieves system-level information about the application that can determine if other sessions are present when exclusive access is required for a table.

DbiGetCurrSession ( phSes )

phSes phDBISes The handle for the current session.

RETURNS: DBIResult

DbiGetCurrSession retrieves the handle for the current session. DbiGetCursorForTable ( hDb, szTableName, szDriverType, phCursor )

hDb szTableName szDriverType phCursor hDBIDb PChar PChar phDBICur

The database handle.

The table name

The name of the driver type.

to the cursor- handle.

RETURNS : DBIResult

DbiGetCursorForTable retrieves the cursor for the specified table in the current session.

DbiGetCursorProps ( hCursor, pcurProps )

hCursor pcurProps hDBICur pCURProps

The cursor handle.

Pointer to a structure of type CURPropS.

RETURNS: DBIResult

The function DbiGetCursorProps retrieves the properties of the specified cursor and places them in the CURProps structure.

The cursor handle.

Pointer to a structure of type CURPropS.

H 320

Part Ill-The Well-Rounded Application

DbiGetDatabaseDesc ( szName, pdbDesc )

szName pdbDesc

PChar pDBDesc

The database name.

Pointer to a structure of type DBDesc.

RETURNS: DBIResult

DbiGetDatabaseDesc retrieves description information about the database from the configuration file and fills the DBDesc structure.

Pointer to a structure of type FMTDate.

DbiGetDateFormat ( pfmtDate )

pfmtDate pFMTDate

RETURNS: DBIResult

DbiGetDateFormat returns the date format for the current session. DbiGetDirectory ( hDb, bDefault, szDir )

hDb bDefault szDir hDBIDb

Boolean

PChar

The database handle.

This parameter determines whether the function will retrieve the default directory or the working directory.

Pointer to the variable that will receive the directory information.

RETURNS: DBIResult

The function DbiGetDirectory retrieves either the default directory or the current directory, depending on the setting in the bDefault parameter.

DbiGetDriverDesc ( szDriverType, pdrvType )

szDriverType pdrvType

PChar pDRVType

The driver name.

Pointer to a structure of type DRVType

RETURNS: DBIResult

The function DbiGetDriverDesc retrieves information about a database driver and fills the DRVType structure.

Was this article helpful?

0 0

Post a comment