Edit

Share via

midiInGetErrorTextA function (mmeapi.h)

  • Article

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

Syntax

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

Parameters

mmrError

Error code.

pszText

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

cchText

Length, in characters, of the buffer pointed to by lpText.

Return value

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

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

Note

The mmeapi.h header defines midiInGetErrorText as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
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

MIDI Functions