midiOutGetErrorText

The midiOutGetErrorText function retrieves a textual description for an error identified by the specified error code.

UINT midiOutGetErrorText(
  MMRESULT mmrError,  
  LPSTR lpText,       
  UINT cchText        
);

Parameters

mmrError
Error code.
lpText
Address of a buffer to be filled with the textual error description.
cchText
Length, in characters, of the buffer pointed to by lpText.

Return Values

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

Value Description
MMSYSERR_BADERRNUM The specified error number is out of range.
MMSYSERR_INVALPARAM The specified pointer or structure is invalid.

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 MMSYSERR_NOERROR. All error descriptions are less than MAXERRORLENGTH characters long.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in mmsystem.h.
  Import Library: Use winmm.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

Musical Instrument Digital Interface (MIDI) Overview, MIDI Functions