|
FireSync API
|
| kStatus kMsgSet_DataAt | ( | kMsgSet | set, |
| kSize | index, | ||
| kArrayList * | list | ||
| ) |
Gets a list of data items at the specified stamp index.
The kMsgSet class assumes that child classes can have multiple data items per stamp. This function provides access to the data items corresponding to a single stamp.
The kMsgSet_DataAt function is intended to be used in environments such as FireSync Studio, rather than the server/pipe processing environment. As such, the implementation of this function is free to assume that sub-objects within the kMsgSet object were all created using the same memory allocator, do not have any external attachments (e.g., via kImage_AttachT), and can therefore be emitted by using kObject_Share.
In cases where the use of kObject_Share is not appropriate, new objects can be dynamically generated without concerns about performance. The memory allocator associated with the kMsgSet instance (accessible via kObject_Alloc) should be used to construct all new objects generated by this function.
The caller is reponsible for disposing the list returned by this function.
This method must be overridden by child classes.
| set | kMsgSet object. |
| index | Item index. |
| list | Receives list of output items. |