Q3Storage_GetData
You can use theQ3Storage_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 the
dataSize
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.
DESCRIPTION
TheQ3Storage_GetData
function returns, through thedata
parameter, some or all of the private data associated with the storage object specified by thestorage
parameter. The data to be returned begins at an offset specified by theoffset
parameter and extends fordataSize
bytes from that location. On exit, thesizeRead
parameter contains the number of bytes actually retrieved from the storage object's private data into thedata
buffer. If the value returned in thesizeRead
parameter is less than the number of bytes requested in thedataSize
parameter, then the end of the storage object's private data occurs at the distanceoffset
+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
.
Main | Top of Section | What's New | Apple Computer, Inc. | Find It | Feedback | Help