midiOutGetErrorText

Syntax

WORD midiOutGetErrorText(wError, lpText, wSize)

This function retrieves a textual description of the error identified by the specified error number.

Parameters

WORD wError

Specifies the error number.

LPSTR lpText

Specifies a far pointer to a buffer to be filled with the textual error description.

WORD wSize

Specifies the length of the buffer pointed to by lpText.

Return Value

Returns zero if the function was successful. Otherwise, it returns an error number. Possible error returns are:

MMSYSERR_BADERRNUM

Specified error number is out of range.

Comments

If the textual error description is longer than the specified buffer, the description is truncated. The returned error string is always null-terminated. If wSize is zero, nothing is copied, and the function returns MMSYSERR_NOERROR. All error descriptions are less than MAXERRORLENGTH characters long.