Gets information about a specific object on the server or locally on the client.
Syntax
ESS_FUNC_M EssGetObjectInfo (hCtx, ObjType, AppName, DbName, ObjName, ppObject);
| Parameter | Data Type | Description |
|---|---|---|
hCtx | ESS_HCTX_T | API context handle. Can be local context handle returned by EssCreateLocalContext(). |
ObjType | ESS_OBJTYPE_T | Object type (must be single type). Refer to Bitmask Data Types (C) for a list of possible values. |
AppName | ESS_STR_T | Application name. |
DbName | ESS_STR_T | Database name. If NULL, uses the application subdirectory. |
ObjName | ESS_STR_T | Object name. |
ppObject | ESS_PPOBJINFO_T | Address of pointer to receive allocated object info structure. |
Notes
The memory allocated for ppObject should be freed using EssFree().
Return Value
If successful, returns an object structure containing information about the appropriate object in ppObject.
Access
This function requires the caller to have the appropriate level of access to the specified application and/or database containing the object (depending on the object type).
See Also