API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

IVECTORMODEL_GETAT()

Brew Release
Brew MP 1.0.2
See Also
- IVectorModel Interface - IVectorModel_InsertAt() - IVectorModel_ReplaceAt()
Description
This function retrieves a pointer to a specific item stored in a vector model. Callers provide to IVectorModel_GetAt() the zero-based index of the item to be retrieved, as well as a pointer to a pointer, into which IVectorModel_GetAt() will return a reference to the requested item.
Params
pif
[]:
[in] Pointer to the IVectorModel interface object.
nIndex
[]:
[in] Indicates the zero-based index of the item to be retrieved. The first item in the model is indexed by 0, the second is indexed by 1, and so on...
ppoItem
[]:
[out] Pointer to a pointer returned by IVectorModel_GetAt() that references the item stored at the designated index position within the model.
Interface
Prototype
  •    int IVectorModel_GetAt(IVectorModel *po, uint32 nIndex, void **ppoItem); 
    
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
Comments
The pointer returned in 'ppoItem' will be NULL when IVectorModel_GetAt() returns AEE_EBADPARM.