FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kStatus kStorageStream_Construct ( kStorageStream stream,
kObject  module,
k32u  deviceId,
const kChar fileName,
kBool  read,
kAlloc  allocator 
)

Constructs a kStorageStream object.

The module argument and device id are used to resolve the storage module. If the the module argument is not a kStorage or kNode object, its ancestors are traversed until a system object is located. The system is then searched for the requested device id, and the first storage module of the selected device is used.

Parameters
streamDestination for the constructed object handle.
moduleA kStorage, kNode, or kSystem object.
deviceIdSensor serial number; ignored if the module argument is a node or storage module.
fileNameFile name.
readIf kTRUE, existing file contents are loaded upon opening.
allocatorMemory allocator (or kNULL for default).
Returns
Operation status.