midiInGetErrorText function

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

Syntax


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 value

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

Return codeDescription
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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Mmsystem.h (include Windows.h)

Library

Winmm.lib

DLL

Winmm.dll

Unicode and ANSI names

midiInGetErrorTextW (Unicode) and midiInGetErrorTextA (ANSI)

See also

MIDI Functions

 

 

Show: