EsbPartitionReadOtlChangeFile

Description

EsbPartitionReadOtlChangeFile() reads changes from a change file (*.CHG) on the target database into memory. This function is designed to be used interactively with EsbPartitionApplyOtlChangeRecs() after a call to EsbPartitionGetOtlChanges(). This function can be used with filters.

Syntax

EsbPartitionReadOtlChangeFile (hCtx, pszChgFileName, QueryFilter, MetaChangeReadHandle, SourceTime)

ByVal hCtx As Long
ByVal pszChgFileName As String
ByRef QueryFilter As ESB_PARTOTL_QRY_FILTER_T
ByRef MetaChangeReadHandle As Long
ByRef SourceTime As Long

Parameters

hCtx Essbase API context handle.
pszChgFileName The name of the metadata change file.
QueryFilter The query filter expression.
MetaChangeReadHandle Handle for the metadata change file.
SourceTime The time of the latest change to the metadata file.

Return Value

Returns zero if successful; error code if unsuccessful.

Notes

This routine returns a time in pMetaChangeRead. This is the same time stamp you should pass to EsbPartitionApplyOtlChangeRecs to update the timestamp at the target database.

Access

A call to this function requires database designer access privileges.

Example

See Also

EsbPartitionApplyOtlChangeFile
EsbPartitionApplyOtlChangeRecs
EsbPartitionCloseDefFile
EsbPartitionFreeDefCtx
EsbPartitionFreeOtlChanges
EsbPartitionGetAreaCellCount
EsbPartitionGetList
EsbPartitionGetOtlChanges
EsbPartitionGetReplCells
EsbPartitionNewDefFile
EsbPartitionOpenDefFile
EsbPartitionPurgeOtlChangeFile
EsbPartitionPutReplCells
EsbPartitionReadDefFile
EsbPartitionResetOtlChangeTime
EsbPartitionReplaceDefFile
EsbPartitionValidateDefinition
EsbPartitionValidateLocal
EsbPartitionWriteDefFile