16 Managing Storage Objects
Q3Storage_GetData
function to get the data stored in a storage object.
TQ3Status Q3Storage_GetData ( TQ3StorageObject storage, unsigned long offset, unsigned long dataSize, unsigned char *data, unsigned long *sizeRead);storage
A storage object.offset
An offset into the private data associated with the specified storage object.dataSize
The number of bytes of data from the specified storage object to be returned in the specified buffer.data
On entry, a pointer to a buffer that is at least large enough to contain the number of bytes of data specified by thedataSize
parameter. On exit, this buffer is filled with data from the specified storage object.sizeRead
On exit, the number of bytes of data read from the specified storage object.
Q3Storage_GetData
function returns, through the data
parameter, some or all of the private data associated with the storage object specified by the storage
parameter. The data to be returned begins at an offset specified by the offset
parameter and extends for dataSize
bytes from that location. On exit, the sizeRead
parameter contains the number of bytes actually retrieved from the storage object's private data into the data
buffer. If the value returned in the sizeRead
parameter is less than the number of bytes requested in the dataSize
parameter, then the end of the storage object's private data occurs at the distance offset
+ sizeRead
from the beginning of the private data.
If the specified storage object is associated with a file object, that file object must be closed before you call Q3Storage_GetData
.
Let us know what you think of these prototype pages.
Generated with Harlequin WebMaker