# EsbPartitionPurgeOtlChangeFile

Description

EsbPartitionPurgeOtlChangeFile() purges changes made previous to the time specified with the TimeStamp parameter.

Syntax

    EsbPartitionPurgeOtlChangeFile (hCtx, pRegion, TimeStamp)

    ByVal hCtx      As Long
          pRegion   As ESB_PART_DEFINED_T
    ByVal TimeStamp As Long

Parameters

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

Return Value

Returns zero if successful; error code if unsuccessful.

Example

    Public Sub Esb_PartitionPurgeOtlChangeFile()

       Dim PartitionInfo As ESB_PART_DEFINED_T
       Dim TimeStamp As Variant

       PartitionInfo.usType = ESB_PARTITION_OP_REPLICATED
       PartitionInfo.Direction = ESB_PARTITION_DATA_SOURCE

       PartitionInfo.HostDatabase.HostName = "Jsnider"
       PartitionInfo.HostDatabase.AppName = "Samppart"
       PartitionInfo.HostDatabase.DbName = "Company"

       TimeStamp = DateDiff("s", #1/1/70#, #7/7/97#)
       sts = EsbPartitionPurgeOtlChangeFile(hCtx, _
                PartitionInfo, TimeStamp)

    End Sub

See Also

Constant and Structure Definitions for Partitions
EsbPartitionApplyOtlChangeFile()
EsbPartitionGetAreaCellCount()
EsbPartitionGetList()
EsbPartitionGetOtlChanges()
EsbPartitionGetReplCells()
EsbPartitionPutReplCells()
EsbPartitionResetOtlChangeTime()