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

Developer

API Reference

JAMS_IAPP_GETNTHAPPPROPERTY()

Brew Release
Brew MP 1.0.2
See Also
jams_IApp_GetNumAppProperties
Description
This function copies the nth property name and its associated value into the requested memory locations. The properties start at 0 and go on until this function returns ENOSUCH. Note that the property names and values are returned in UTF-8 format. There is no maximum length for property names or values.
Params
me
[]:
Pointer to the interface object.
nNthProperty
[]:
The nth app property to retrieve. This value starts at 0 and ends when this function returns ENOSUCH.
pszName
[]:
Buffer where property name is returned, in UTF-8 format. May be NULL if information is not desired.
nNameLen
[]:
Maximum length of property name buffer in characters including the null terminator. Property may be truncated to fit in buffer, but will always be null-terminated.
nNameLenReq
[]:
Length in chars taht would be required to return the complete string including the null terminator.
pszValue
[]:
Buffer where property value is returned, in UTF-8 format. May be NULL if information is not desired.
nValueLen
[]:
Maximum length of property value buffer in characters including the null terminator. Property may be truncated to fit in buffer, but will always be null-terminated.
nValueLenReq
[]:
Length in chars taht would be required to return the complete string including the null terminator.
Interface
Prototype
  •    AEEResult jams_IApp_GetNthAppProperty
       (
          jams_IApp*	me,
          int         nNthProperty,
          char*       pszName,
          int         nNameLen,
          int*        pnNameLenReq,
          char*       pszValue,
          int         nValueLen,
          int*        pnValueLenReq
       );
    
Return
  • AEE_SUCCESS The nth name and/or value have been retrieved. AEE_ENOSUCH The nth property does not exist. AEE_EFAILED or other for unspecified errors.
Side Effect
  • None
Comments
None