asxstring.h File Reference

Go to the source code of this file.

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.

---

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: nEnum  The enum value to translate. szString  The 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. nLength  The length of szString. pRequiredLength  The required minimum length of the caller's char array. Returns: Returns 0 on success. Examples: dual_mono_play/main.c, dual_mono_record/main.c, mixer/main.c, mux/main.c, play/main.c, and tuner/main.c.

ASX32_API int ASXSTRING_StringToEnum (  const char *  szString, int *  pnEnum )

Translate a string into an ASX enum. Parameters: szString  The string to look up in enum list. pnEnum  The enum value returned. Returns: Returns 0 on success.

---