Developer

API Reference

IListModel_GetAt()

Brew Release
Brew MP 1.0.2
See Also
- IListModel Interface
Description
This function retrieves a specified item from of a given list model. IListModel_GetAt() is supplied as a stub and is intended to be over ridden by access methods in more sophisticated models that derive from IListModel.
Parameters
  • pif
    []:
    Pointer to the IListModel interface object.
  • nIndex
    []:
    Indicates the zero-based index of the list item. The first item in the list is indexed by 0, the second is indexed by 1, and so on...
  • ppo
    []:
    Pointer to a pointer returned by IListModel_GetAt() that references the item stored at the designated index position within the model.
Interface
Prototype
   int IListModel_GetAt(IListModel *pif, uint32 nIndex, void **ppo); 
Return
   AEE_SUCCESS   - The model was able to successfully return a pointer to the requested item.
   AEE_EBADPARM  - The requested index is not within the range of items stored in the model.
Side Effect
None
Comment
The reference implementation always returns AEE_EBADPARM.
  • Follow