EssPutObject

Copies an object from a local file to the server or client object system, and optionally unlocks it.

Syntax

ESS_FUNC_M  EssPutObject (hCtx, ObjType, AppName, DbName, ObjName, LocalName, Unlock);

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	Name of object to put.
LocalName	ESS_STR_T	Full path name of local source file on client.
Unlock	ESS_BOOL_T	Flag to control object unlocking. If TRUE, the server object is unlocked to allow updates by other users.

Notes

In order to put an object which already exists on the server, it must have previously been locked by the caller. If the object does not already exist on the server, it will be created.

Return Value

If successful, the object is copied to the server from the local file specified by LocalName.

Access

This function requires the caller to have the appropriate level of access to the specified application and/or database to contain the object (depending on the object type). To unlock the object (unlock flag is TRUE), the caller must 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_PutObject (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;     
   ESS_STR_T         LocalName;
   ESS_BOOL_T        UnLock; 
   
   AppName   = "Sample";
   DbName    = "Basic";
   ObjName   = "Basic1";
   ObjType   = ESS_OBJTYPE_OUTLINE; 
   LocalName = "C:\\Hyperion\\products\\Essbase\\EssbaseClient\\Test.otl";
   UnLock    = ESS_TRUE;
   
   sts = EssPutObject (hCtx, ObjType, AppName,
         DbName, ObjName, LocalName, UnLock); 
   return (sts);
}