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

Developer

API Reference

IADDRREC_REMOVEFIELD()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IAddrRec IADDRREC_UpdateField IADDRREC_AddField
Description
This function removes the field at the given index position. The index is zero-based.
Params
pIAddrRec
[in]:
Pointer to the IAddrRec interface object.
nFieldx
[in]:
Specifies the index position at which the field is to be deleted.
Interface
  • IADDRREC
Prototype
  •     int IADDRREC_RemoveField(IAddrRec * pIAddrRec, int nFieldIdx);
    
Return
  • AEE_SUCCESS : If successful. AEE_EFAILED : General failure. AEE_ENOMEMORY : Insufficient memory.
Side Effect
  • None
Comments
Some fields may be required on some devices. For example, a device may require that a name field always be present, or a device may require that at least one number, email address, or content be present in a record.