Name

 
waveOutGetErrorText --- Retrieve a text description of the error identified by the specified error number
 
 

Syntax

 #include <mme/mme_api.h>
 MMRESULT waveOutGetErrorText(UINT uError,
                             LPSTR lpText,
                             UINT uSize);
 

Arguments

 
UINT uError
Specifies the error number.

 
LPSTR lpText
Specifies a pointer to a buffer to be filled with the text error description. The buffer must be allocated with the mmeAllocMem function before being passed to the waveOutGetErrorText function. 
 
 
 
 
See the mmeAllocMem(3mms) reference page for more information about allocating memory for the lpText argument. 
 
 

 
UINT uSize
Specifies the size in bytes of the buffer pointed to by the lpText argument. 
 
 

Description

 
The waveOutGetErrorText function retrieves a text description of the error identified by the specified error number. If the text error description is longer than the specified buffer, the description is truncated. The returned error string is always null terminated.  If uSize is zero, nothing is copied, and the function returns the MMSYSERR_NOERROR error code. All error descriptions are fewer than MAXERRORLENGTH characters long. 
 

Extensions

 
None.
 
 

Return Values

 
Returns MMSYSERR_NOERROR if the function is successful; otherwise, it returns the following error code:
 
 

 
MMSYSERR_BADERRNUM@T{ The specified error number is out of range. T}

See Also

 
None.