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

Developer

API Reference

FUNCTION: WWRITELONGEX()

Brew Release
Brew MP 1.0.2
See Also
WSPRINTF() WWRITELONG() Helper Functions
Description
This function converts a long number into wide string. The string may be padded with a wide character "0" (zero), and may contain only a portion of the long input value based on the nPad and nRemaining parameters.
Params
pszBuf
[out]:
A valid pointer to a NULL-terminated wide string to which the converted long is written.
n
[in]:
A long number.
nPad
[in]:
Specifies the maximum amount of padding. It must be less than 12; otherwise it is ignored. It specifies the number of digits that must be present in the final string. For example, if n is set to 245 and nPad is set to 5, then the output string shall contain 00245.
nRemaining
[]:
[in/out]: On input, this points to an integer that specifies the size of pszBuf. This is specified in terms of the total number of characters (AECHARs) including the padding, that can be written to the string. On output, this points to an integer that denotes the unused space (in terms of the number of ARCHARs) left in pszBuf. The difference between the output and input values denotes the number of characters written to pszBuf (excluding the NULL character).
Prototype
  •    AECHAR *WWRITELONGEX(AECHAR *pszBuf, long n, int nPad, int *pnRemaining);
    
Return
  • If successful, returns a pointer to the beginining of the unused portion of pszBuf. This is the portion in pszBuf after the formatted wide string has been written.
    If failed, returns NULL.
Side Effect
  • None
Comments
None