NAME
SPROX_ArrayToString
DESCRIPTION
Translate an array of bytes into a string of hexadecimal digits
INPUTS
TCHAR *string : buffer to hold the hexadecimal string const BYTE *buffer : byte array WORD size : size of byte array
RETURNS
MI_OK : success
NOTES
You must ensure that size of string buffer is enough to store the whole hexadecimal string (i.e. at least 2 * size characters)
VARIANTS
SPROX_ArrayToStringA : ASCII version SPROX_ArrayToStringW : UNICODE version
NAME
SPROX_Free
DESCRIPTION
Desallocation of a dynamic buffer
INPUTS
BYTE *buffer : address of the allocated buffer
RETURNS
MI_OK : success
SEE ALSO
SPROX_Malloc
NAME
SPROX_GetErrorMessage
DESCRIPTION
Retrieve an english string explaining a function returned code
INPUTS
SWORD status : SpringProxAPI function returned value
RETURNS
const TCHAR * : pointer to the translation string
WARNING
The string returned is physically static in the SpringProxAPI address space. Do not try to change it nor to free the returned pointer.
VARIANTS
SPROX_GetErrorMessageA : ASCII version SPROX_GetErrorMessageW : UNICODE version
NAME
SPROX_Malloc
DESCRIPTION
Dynamic allocation of a buffer
INPUTS
BYTE **buffer : pointer to receive the address of the allocated buffer WORD size : size of the buffer
RETURNS
MI_OK : success
NOTES
The buffer must be freed using SPROX_Free
NAME
SPROX_StringToArray
DESCRIPTION
Translate a string of hexadecimal digits into an array of bytes
INPUTS
BYTE *buffer : byte array to receive the result const TCHAR *string : hexadecimal string WORD size : size of the byte array
RETURNS
MI_OK : success
NOTES
The length of the string must be equals to 2 * size
VARIANTS
SPROX_StringToArrayA : ASCII version SPROX_StringToArrayW : UNICODE version
NAME
SPROX_StrLen
DESCRIPTION
Determines the length of a string
INPUTS
const TCHAR *string : input string
RETURNS
WORD : actual length (= number of characters) of the string
VARIANTS
SPROX_StrLenA : ASCII version SPROX_StrLenW : UNICODE version