midiInGetErrorText

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

MMRESULT midiInGetErrorText(
  MMRESULT wError,  
  LPTSTR lpText,     
  UINT cchText      
);

Parameters

wError

Error code.

lpText

Pointer to the 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.
MMSYSERR_NOMEM The system is 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

  Windows NT/2000/XP: Included in Windows NT 3.1 and later.
  Windows 95/98/Me: Included in Windows 95 and later.
  Header: Declared in Mmsystem.h; include Windows.h.
  Library: Use Winmm.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000/XP.

See Also

Musical Instrument Digital Interface (MIDI), MIDI Functions

Show: