EssUnlockObject

Unlocks a locked object on the server or client object system.

Syntax

ESS_FUNC_M  EssUnlockObject (hCtx, ObjType, AppName, DbName, ObjName); 
ParameterData TypeDescription

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

databasename. If NULL, uses the Application subdirectory.

ObjName

ESS_STR_T

Name of object to unlock

Notes

To unlock an object, the object must already exist and be locked by the caller.

Return Value

None.

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_UnlockObject (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 = "Basic";
   ObjType = ESS_OBJTYPE_OUTLINE; 
   
   sts = EssUnlockObject(hCtx, ObjType, AppName,
         DbName, ObjName); 
   if(!sts)
      printf("The Object is unlocked\r\n");
   return (sts);
}

See Also