Developer

API Reference

IvProperty_GetParmAtIndex()

Brew Release
Brew MP 1.0.2
See Also
None
Description
Retrieves the IvParm object specified by nParmId and index
Passing in 0(zero) for the nParmId, retrieves the IvParm object at that index
Parameters
  • pIvProperty
    []:
    Pointer to the interface object
  • nParmId
    []:
    Parameter Id for which the object has to be retrieved
  • nIndex
    []:
    The index at which the object has to be retrieved, the index is zero based
  • ppIvParm
    []:
    Holds a pointer to the returned IvParm object
Interface
Prototype
   int IvProperty_GetParmAtIndex(IvProperty    *pIvProperty,
                                 AEEVParameter nParmId,
                                 int           nIndex,
                                 IvParm        **ppIvParm);
Return
AEE_SUCCESS : If we are able to get the object AEE_EBADPARM : If either nParmId or nIndex is invalid or ppIvParm is NULL AEE_ENOMEMORY : If we are unable to allocate the memory AEE_EFAILED : Otherwise
Side Effect
The returned object reference count is incremented
Comment
None
  • Follow