Developer

API Reference

IxOpts_GetOpt()

Brew Release
Brew MP 1.0.2
See Also
None
Description

Find a xOpt in the list of xOpts in pIxOpts matching nOptId. There may be multiple matches (either in the case of a multi-valued xOpt, or in the case of overrides). In this case nIndex specifies how far into the list of xOpts that match nOptId to look. pItem is filled in with the matching xOpt contents. nIndex is zero-based.
Parameters
  • pIxOpts
    []:
    the interface pointer.
  • nOptId
    []:
    id of the option to find in the options list, XOPT_ANY returns the nIndexth option, if there is one...
  • nIndex
    []:
    which (if there are multiple xOpts of the same id) to get nIndex counts from most recently AddOpt()ed option, it's zero-based.
  • pItem
    []:
    where to stick the found xOpt
Interface
Prototype
   int IxOpts_GetOpt(IxOpts *pIxOpts, int32 nOptId, int32 nIndex,
                       xOpt *pItem)
Return
AEE_SUCCESS: if the options could be added successfully AEE_EFAILED: if the specified xOpt couldn't be found AEE_EBADPARM: if pItem is NULL
Side Effect
None
Comment
None
  • Follow