waveInGetErrorText
A version of this page is also available for
4/8/2010
This function retrieves a textual description of the error identified by the specified error number.
Syntax
MMRESULT waveInGetErrorText(
MMRESULT mmrError,
LPTSTR pszText,
UINT cchText
);
Parameters
- mmrError
Error number.
- pszText
Address of the buffer to be filled with the textual error description.
- cchText
Size, in characters, of the buffer pointed to by pszText.
Return Value
One of the values described in the following table is returned.
Value | Description |
---|---|
MMSYSERR_NOERROR |
Success. |
MMSYSERR_BADERRNUM |
Specified error number is out of range. |
MMSYSERR_NODRIVER |
No device driver is present. |
MMSYSERR_NOMEM |
Unable to allocate or lock memory. |
Remarks
If the textual error description is longer than the specified buffer, the description is truncated. The returned error string is always null-terminated. If cchText is zero, nothing is copied and the function returns zero. All error descriptions are less than MAXERRORLENGTH characters long.
Requirements
Header | mmsystem.h |
Library | coredll.lib |
Windows Embedded CE | Windows CE 2.0 and later |
Windows Mobile | Windows Mobile Version 5.0 and later |