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

Developer

API Reference

ITIMEZONE_GETSUPPORTED()

Brew Release
Brew MP 1.0.2
See Also
None
Description
This function retrieves a list of suported timezones. The string returned contains the timezone names in the standard name (tz database name) format. e.g. "America/Los_Angeles,America/New_York,America/Chicago,America/Denver" only these 4 timezone were supported. In practice this is likely to be a fairly large list of timezones depending on the system.
Params
_pif
[]:
A pointer to the ITimeZone object.
Names
[]:
The standard names (tz database names) of all the supported timezones in a comma-separated list.
NamesLen
[]:
The number of 'char' elements including the null terminator, that can be stored in 'Names'. Note that this may be greater than the actual length of the input string, but it may not be less. Please see comments below.
NamesLenReq
[]:
On success, the total number of 'char' elements that make up 'Names' plus a null terminator.
Interface
Prototype
  •    AEEResult ITimeZone_GetSupported(ITimeZone* _pif, char* Names, 
                                        int NamesLen, int* NamesLenReq);
    
Return
  • AEE_SUCCESS: If the supported timezone were retrieved successfully. Error code: indicating the nature of the failure otherwise.
Side Effect
  • None
Comments
The caller must provide a valid buffer, 'Names', which can hold up to 'NamesLen' characters (including the null terminator). Note that, however, when 'NamesLen' is 0, 'Names' may be NULL. Upon successful return, 'NamesLenReq' will indicate the number of characters, including the null terminator, which would have been required to store the entire result. If, upon successful return, 'NamesLenReq' is less than or equal to 'NamesLen', then 'Names' contains the entire result; otherwise, 'Names' contains the truncated result (i.e., the first 'NamesLen-1' characters plus a null terminator). On successful return, the returned string 'Names' will always be null terminated.