ASX Version4.13.09
Defines | Functions

asxstring.h File Reference

Go to the source code of this file.

Defines

#define ASX32_API

Functions

ASX32_API int ASXSTRING_EnumToString (const int nEnum, char *szString, const int nLength, int *pRequiredLength)
 Translate an ASX enum into a string.
ASX32_API int ASXSTRING_StringToEnum (const char *szString, int *pnEnum)
 Translate a string into an ASX enum.

Define Documentation

#define ASX32_API

Function Documentation

ASX32_API int ASXSTRING_EnumToString ( const int  nEnum,
char *  szString,
const int  nLength,
int *  pRequiredLength 
)

Translate an ASX enum into a string.

Parameters:
nEnumThe enum value to translate.
szStringThe returned string is copied here. The caller should allocate enough memory to hold the returned string. Call this function with szString=0 and check the RequiredLength field to determine how much memory to allocate.
nLengthThe length of szString.
pRequiredLengthThe required minimum length of the caller's char array.
Returns:
Returns 0 on success.
Examples:
cobranet/main.c, dual_mono_play/main.c, dual_mono_record/main.c, mixer/main.c, mux/main.c, play/main.c, playlist/main.c, tuner/main.c, and volume/main.c.
ASX32_API int ASXSTRING_StringToEnum ( const char *  szString,
int *  pnEnum 
)

Translate a string into an ASX enum.

Parameters:
szStringThe string to look up in enum list.
pnEnumThe enum value returned.
Returns:
Returns 0 on success.