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

Developer

API Reference

ICALLMGR_GETORIGOPT()

Brew Release
Brew MP 1.0.2
See Also
IWEBOPTS_GetOpt().
Description
Retrieves the origination option identified by nOptId at the index nIdx. The option identifier must be one of AEET_ORIGOPT_* values.
Params
po
[]:
the interface pointer.
nOptId
[]:
Origination option to retrieve.
nIdx
[]:
index to the option if there are multiple options with the same id. This index is zero-based and counts from most recently AddOpt()ed option
pwo
[]:
buffer to place the option information. For certain option IDs, this points to internal data. Applications should make a copy of this data in order to use it beyond the scope of this API.
Interface
  • ICALLMGR
Prototype
  •    int ICALLMGR_GetOrigOpt( ICallMgr *po, int32 nOptId, int32 nIdx, AEETOriginateOpt *pwo );
    
Return
  • SUCCESS : When the option is found. EFAILED : the option is cleared or not initialized.
Side Effect
  • None
Comments
When succeeded, depending on the type of data retrieved in pwo->pVal will be referring to internal data buffer. Application must make a copy depending on the scope of use.