EssGetObjectInfo
Description
EssGetObjectInfo() 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);
ESS_HCTX_T | hCtx |
ESS_OBJTYPE_T | ObjType |
ESS_STR_T | AppName |
ESS_STR_T | DbName |
ESS_STR_T | ObjName |
ESS_PPOBJINFO_T | ppObject |
Parameters
hCtx | Essbase API context handle. Can be local context handle returned by EssCreateLocalContext().
|
ObjType | Object type (must be single type). Refer to Bitmask Data Types for a list of possible values.
|
AppName | Application name. |
DbName | Database name. If NULL, uses the application subdirectory.
|
ObjName | Object name. |
ppObject | Address of pointer to receive allocated object info structure.
|
Return
Value
If successful, returns an object structure containing information
about the appropriate object in ppObject.
Notes
- The memory allocated for ppObject should be freed using
EssFree().
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
EssGetObject()
EssListObjects()