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_ThCtx
ESS_OBJTYPE_TObjType
ESS_STR_TAppName
ESS_STR_TDbName
ESS_STR_TObjName
ESS_PPOBJINFO_TppObject

Parameters

hCtxEssbase API context handle. Can be local context handle returned by EssCreateLocalContext().
ObjTypeObject type (must be single type). Refer to Bitmask Data Types for a list of possible values.
AppNameApplication name.
DbNameDatabase name. If NULL, uses the application subdirectory.
ObjNameObject name.
ppObjectAddress 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

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()