# EsbPartitionApplyOtlChangeFile

Description

EsbPartitionApplyOtlChangeFile() requests server to apply a list of outline change files.

Syntax

    EsbPartitionApplyOtlChangeFile (hCtx, usFileNum, fileList)

    ByVal hCtx      As Long
    ByVal usfilenum As Integer
    ByVal filelist  As String

Parameters

hCtx | Handle to Essbase API context.
usFileNum | The number of outline change files.
fileList | A string of filenames delimited by CR/LF. The size of the array is defined by usFileNum.

Return Value

Returns zero if successful, error code if unsuccessful.

Notes

- Obtain filename by calling EsbPartitionGetOtlChanges().

Access

Database designer access privileges are required.

Example

    Public Sub ESB_PartitionApplyOtlChangeFile()

       Dim FileItems As Integer
       Dim Filelist As String
       Dim ProcState As ESB_PROCSTATE_T

       FileItems = 1
       Filelist = "C:\ESSBASE\APP\SAMPPART\COMPANY\ESS00001.CHG"

       sts = EsbPartitionApplyOtlChangeFile(hCtx, FileItems, Filelist)

       If sts = 0 Then
          sts = EsbGetProcessState(hCtx, ProcState)
          Do Until ProcState.State = ESB_STATE_DONE
             sts = EsbGetProcessState(hCtx, ProcState)
          Loop
       End If

    End Sub

See Also

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