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

Developer

API Reference

IADDRREC_GETFIELD()

Brew Release
Brew MP 1.0.2
See Also
AEEAddrField IAddrRec IADDRREC_GetFieldCount
Description
This function retrieves information about the field at the given index. The index is zero based and ranges from zero to NumFields -1 (where NumFields is the number of fields in this record). The pointer returned by this function must not be freed or tampered with by the caller. It is automatically freed when this record is released. If modifications need to be made to this field, the function IADDRREC_UpdateField() must be called for the modifications to take effect.
Params
pIAddrRec
[]:
Pointer to the IAddrRec Interface object.
nFieldIdx
[]:
Specifies the index of the field whose information is to be retrieved. This index is zero-based.
Interface
  • IADDRREC
Prototype
  •     AEEAddrField * IADDRREC_GetField(IAddrRec * pIAddrRec, int nFieldIdx);
    
Return
  • Pointer to AEEAddrField at the current index position : If successful. NULL : If the function fails.
Side Effect
  • None
Comments
None