waveOutGetErrorText function

The waveOutGetErrorText function retrieves a textual description of the error identified by the given error number.

Syntax

MMRESULT waveOutGetErrorText(
  MMRESULT mmrError,
  LPSTR    pszText,
  UINT     cchText
);

Parameters

mmrError

Error number.

pszText

Pointer to a buffer to be filled with the textual error description.

cchText

Size, in characters, of the buffer pointed to by pszText.

Return Value

Returns MMSYSERR_NOERROR if successful or an error otherwise. Possible error values include the following.

Return code Description
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

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header mmeapi.h (include Windows.h)
Library Winmm.lib
DLL Winmm.dll

See Also

Waveform Audio

Waveform Functions