HyperFile

Detailed Description

Functions

FILEERROR ReadHyperFile (BaseDocument *doc, GeListNode *node, const Filename &filename, Int32 ident, String *warning_string)
 
FILEERROR WriteHyperFile (BaseDocument *doc, GeListNode *node, const Filename &filename, Int32 ident)
 

Function Documentation

§ ReadHyperFile()

FILEERROR ReadHyperFile ( BaseDocument doc,
GeListNode node,
const Filename filename,
Int32  ident,
String warning_string 
)

Reads a single list node from a hyper file on disk.
The read data replaces the data in node.

Note
To dynamically read/write many objects, just pass a GeListHead as node.
Parameters
[in]docThe document of node. The caller owns the pointed document.
[out]nodeThe node to read to. Must be allocated before the call. The caller owns the pointed node.
[in]filenameA valid filename to read from.
[in]identA unique file identification.
[in]warning_stringAssigned additional error information if passed. The caller owns the pointed string.
Returns
The file result: FILEERROR

§ WriteHyperFile()

FILEERROR WriteHyperFile ( BaseDocument doc,
GeListNode node,
const Filename filename,
Int32  ident 
)

Writes a single list node to disk as a hyper file.

Parameters
[in]docThe document of node. The caller owns the pointed document.
[in]nodeThe node to write. The caller owns the pointed node.
[in]filenameA valid filename to write to.
[in]identA unique file identification.
Returns
The file result: FILEERROR