Reads a partition definition file into memory.
Syntax
ESS_FUNC_M EssPartitionReadDefFile (hCtx, iFileHandle, pDdbCtx);
Parameter | Data Type | Description |
---|---|---|
hCtx | ESS_HCTX_T | API context handle. |
iFileHandle | ESS_INT_T | Handle to partition definitions file. |
pDdbCtx | ESS_PART_T | Distributed database context to be filled. |
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().
Return Value
Returns zero if successful; error code if unsuccessful.
Example
For an example, see EssPartitionOpenDefFile.
See Also