# EssPartitionReadDefFile

Description

EssPartitionReadDefFile() reads a partition definition file into memory.

Syntax

    ESS_FUNC_M EssPartitionReadDefFile (hCtx, iFileHandle, pDdbCtx);

ESS_HCTX_T | hCtx
ESS_INT_T | iFileHandle
ESS_PPART_T | pDdbCtx

Parameters

hCtx | Essbase API context handle.
iFileHandle | Handle to partition definitions file.
pDdbCtx | Distributed database context to be filled.

Return Value

Returns zero if successful; error code if unsuccessful.

Notes

- Use this function as part of a sequence of definition operations. Use EssPartitionOpenDefFile() to open existing definition files. Use EssPartitionNewDefFile() to create and open a new definition file. Use EssPartitionReadDefFile() or EssPartitionWriteDefFile() to read or write a definition file. Close with EssPartitionCloseDefFile(). Then free the memory with EssPartitionFreeDefCtx().

Example

For an example, see EssPartitionOpenDefFile()

See Also

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