midiInGetErrorText
The midiInGetErrorText
function retrieves a textual description for an error identified by the
specified error code.
MMRESULT midiInGetErrorText(
|
MMRESULT wError, |
|
|
LPSTR lpText, |
|
|
UINT cchText |
|
|
); |
|
Parameters
wError
Error code.
lpText
Address of
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:
|
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.