EssBuildDimFile

Description

EssBuildDimFile() builds a data file used to add or remove members from the active database outline. See EssBuildDimension() for more information.

Syntax
ESS_FUNC_M EssBuildDimFile (hCtx, RulesObj, DataObj, MbrUser, 
ErrorName, fOverwriteErrorFile);
ESS_HCTX_ThCtx
ESS_POBJDEF_T RulesObj
ESS_POBJDEF_T DataObj
ESS_PMBRUSER_T MbrUser
ESS_STR_TErrorName
ESS_BOOL_TfOverwriteErrorFile

Parameters

hCtxEssbase API context handle.
RulesObjPointer to rules file object definition structure.
DataObjPointer to data file object definition structure.
MbrUserSQL user structure (if data source is SQL database). NULL structure indicates a non-SQL data source.
ErrorNameError name output on client.
fOverwriteErrorFileA Boolean value which detemines whether this function overwrites an existing file name ErrorFile.

Return Value

Returns a zero if successful.

Notes

Access

This function requires database design privilege ESS_PRIV_DBDESIGN for the specified database.

Example

ESS_FUNC_M EssBuildDimFile (ESS_HCTX_T hCtx)
{
   ESS_FUNC_M sts = ESS_STS_NOERR;
   ESS_OBJDEF_T RulesObj;
   ESS_OBJDEF_T DataObj;
   ESS_STR_T ErrorName;
   
   RulesObj.hCtx = hCtx;
   RulesObj.FileName = "Prodmap";
   RulesObj.ObjType = ESS_OBJTYPE_RULES;
   
   DataObj.hCtx = hCtx;
   DataObj.FileName = "Prodtabl";
   DataObj.ObjType = ESS_OBJTYPE_TEXT;
   ErrorName = "builddim.err";
   
   sts = EssBuildDimFile (hCtx, &RulesObj,
         &DataObj, NULL, ErrorName);
   return (sts);
}

See Also

EssImport()
EssBuildDimension()
EssBuildDimStart()
EssOtlRestructure()
EssUnlockObject()