EsbPartitionGetOtlChanges

Description

EsbPartitionGetOtlChanges() pulls outline changes from a given source and stores them in a file.

Syntax

EsbPartitionGetOtlChanges (hCtx, MetaQuery, ChangeFile, szChangeFile) 
ByVal hCtx         As Long
      MetaQuery    As ESB_PARTOTL_QUERY_T 
ByVal ChangeFile   As String
ByVal szChangeFile As Integer

Parameters

hCtx Essbase API context handle.
MetaQuery Change query criteria.
ChangeFile Caller allocated change file and informational structure.
szChangeFile The size of the change file.

Return Value

Returns zero if successful, error code if unsuccessful.

Notes

Multiple files must be passed as a CR/LF delimited file list. You must use the path name on the server (as referenced by EsbGetOtlChanges()).

Access

A call to this function requires database designer access privileges.

Example

Public Sub ESB_PartitionGetOtlChanges()

   Dim PartQuery As ESB_PARTOTL_QUERY_T
   Const SizeofChangeFile = 150
   Dim ChangeFile As String * SizeofChangeFile
   
   PartQuery.OperationType = ESB_PARTITION_OP_REPLICATED
   PartQuery.HostDatabase.HostName = "Dscharton2"

   PartQuery.HostDatabase.AppName = "Sampeast"
   PartQuery.HostDatabase.DbName = "East"
   

   PartQuery.MetaFilter.TimeStamp = _
      DateDiff("s", #1/1/70#, #6/18/97#)

   PartQuery.MetaFilter.DimFilter = ESB_PARTITION_OTLDIM_ALL
   PartQuery.MetaFilter.MbrFilter = ESB_PARTITION_OTLMBR_ALL
   PartQuery.MetaFilter.MbrAttrFilter = _   
                                ESB_PARTITION_OTLMBRATTR_ALL
   
   sts = EsbPartitionGetOtlChanges(hCtx, PartQuery, _ 
                           ChangeFile, SizeofChangeFile)

   If sts = 0 Then MsgBox ChangeFile
 
End Sub

See Also

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