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

C syntax

DBIResult DBIFN DbiGetObjFromName (eObjType, [pszObjName], phObj);

Delphi syntax

function DbiGetObjFromName (eObjType: DBIOBJType; pszObjName: PChar; var hObj: hDBIObj): DBIResult stdcall;

Description

DbiGetObjFromName returns an object handle of the specified type or with the given name, if any.

Parameters

eObjType                Type: DBIOBJType                (Input)
Specifies the type of object.

pszObjName                Type: pCHAR                (Input)
Pointer to the name of the object. Optional.

phObj                Type: phDBIObj                (Output)
Pointer to the object handle.

Usage

Some handles can be retrieved only by name, such as handles associated with cursors. For those, pszObjName is not optional. There can be more than one cursor open for a given table name; DbiGetObjFromName returns the handle to one of those cursors. To get a session handle, the session name need not be specified; by default, a handle to the currently active session is returned.