EssDeleteObject

Description

EssDeleteObject() deletes an existing object.

Syntax
ESS_FUNC_M EssDeleteObject (hCtx, ObjType, AppName, DbName, ObjName);
ESS_HCTX_ThCtx
ESS_OBJTYPE_TObjType
ESS_STR_TAppName
ESS_STR_TDbName
ESS_STR_TObjName

Parameters

hCtxEssbase API context handle.
ObjTypeObject type (must be single type).
AppNameApplication name.
DbNameDatabase name. If NULL, uses the application subdirectory.
ObjNameObject name to delete.

Return Value

None.

Notes

Access

This function requires the caller to have Application or Database Design privilege (ESS_PRIV_APPDESIGN or ESS_PRIV_DBDESIGN) for the specified application or database containing the object.

Example

ESS_FUNC_M 
ESS_DeleteObject (ESS_HCTX_T  hCtx)
{
   ESS_FUNC_M         sts = ESS_STS_NOERR;
   ESS_STR_T         AppName;
   ESS_STR_T         DbName;
   ESS_STR_T         ObjName;
   ESS_OBJTYPE_T     ObjType;
   AppName = "Sample";
   DbName  = "Basic";
   ObjName = "Test";
   ObjType = ESS_OBJTYPE_TEXT;
   sts = EssDeleteObject(hCtx, ObjType, AppName,
         DbName, ObjName);
   return (sts);
}

See Also

EssCreateObject()
EssListObjects()