EssPartitionPurgeOtlChangeFile

Description

Purges changes made previous to the time specified with the TimeStamp parameter.

Syntax

ESS_FUNC_M EssPartitionPurgeOtlChangeFile (hCtx, pPartition, TimeStamp);

ESS_HCTX_T hCtx;
ESB_PPART_DEFINED_T pPartition;
ESS_TIME_T TimeStamp;

Parameters

hCtx Essbase API context handle.
pPartition Partition specification
TimeStamp Purge all change records before this time.

Return Value

Returns zero if successful, error code if unsuccessful.

Notes

Example

ESS_STS_T   ESS_PartitionPurgeOtlChangeFile(ESS_HCTX_T hCtx)
{
   ESS_STS_T          sts;
   ESS_STR_T         hostname, appname, dbname;
   ESS_USHORT_T       usType,usdir;
   ESS_PART_DEFINED_T Partition;

   memset(&Partition, 0, sizeof(ESS_PART_DEFINED_T));
   
   hostname = "local";
   appname = "App1";
   dbname = "Src1";

   usType = ESS_PARTITION_OP_LINKED;
   usdir = ESS_PARTITION_DATA_TARGET;

   Partition.usType = usType;
   Partition.usDirection = usdir;
   Partition.HostDatabase.pszHostName = hostname;
   Partition.HostDatabase.pszAppName = appname;
   Partition.HostDatabase.pszDbName = dbname;

   sts = EssPartitionPurgeOtlChangeFile (hCtx, &Partition, 0);

   printf("EssPartitionPurgeOtlChangeFile   sts:  %ld\n",sts);

   return(sts);
   
}

See Also

Constant and Structure Definitions for Partitions
EssPartitionApplyOtlChangeFile()
EssPartitionApplyOtlChangeRecs()
EssPartitionCloseDefFile()
EssPartitionFreeDefCtx()
EssPartitionFreeOtlChanges()
EssPartitionGetAreaCellCount()
EssPartitionGetList()
EssPartitionGetOtlChanges()
EssPartitionGetReplCells()
EssPartitionNewDefFile()
EssPartitionOpenDefFile()
EssPartitionPutReplCells()
EssPartitionReadDefFile()
EssPartitionReadOtlChangeFile()
EssPartitionReplaceDefFile()
EssPartitionResetOtlChangeTime()
EssPartitionValidateDefinition()
EssPartitionWriteDefFile()