EssPartitionOpenDefFile

Opens an existing shared-partition definition file.

Syntax

ESS_FUNC_M EssPartitionOpenDefFile (hCtx, pszFileName, piFileHandle, ppDdbCtx);

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle.
pszFileName	ESS_STR_T	Name of file to be opened (complete path).
piFileHandle	ESS_PINT_T	Handle to created file.
ppDdbCtx	ESS_PART_T	An initialized distributed context.

Return Value

Returns zero if successful; error code if unsuccessful.

Example

ESS_FUNC_M ESS_PartitionOpenDefFile(ESS_HCTX_T hCtx)
{
   ESS_FUNC_M        sts = 0;
   ESS_INT_T        iFileHandle;
   ESS_STR_T        pszFileName;
   ESS_PART_T       DdbCtx, *pDdbCtx; 
   pszFileName = "C:\\Hyperion\\products\\Essbase\\EssbaseServer\\app\\app1\\trg1\\trg1.ddb";
   sts = EssPartitionOpenDefFile(hCtx,pszFileName,&iFileHandle,&pDdbCtx);
   printf("EssPartitionOpenDefFile  sts: %ld\n",sts);

   if (!sts)  
   {  
           sts = EssPartitionReadDefFile(hCtx,iFileHandle,&DdbCtx);
           printf("\tEssPartitionReadDefFile  sts: %ld\n",sts);

       /* ...
          ...  process definition file information
          ...
       */
           sts = EssPartitionCloseDefFile(hCtx,iFileHandle);
                
       printf("\tEssPartitionCloseDefFile   sts: %ld\n",sts);

           sts = EssPartitionFreeDefCtx(hCtx,pDdbCtx);
                
       printf("\tEssPartitionFreeDefCtx   sts: %ld\n",sts);

   }
   return (sts);
}