Share via


mciGetErrorString function

The mciGetErrorString function retrieves a string that describes the specified MCI error code.

Syntax

BOOL mciGetErrorString(
   DWORD  fdwError,
   LPTSTR lpszErrorText,
   UINT   cchErrorText
);

Parameters

  • fdwError
    Error code returned by the mciSendCommand or mciSendString function.

  • lpszErrorText
    Pointer to a buffer that receives a null-terminated string describing the specified error.

  • cchErrorText
    Length of the buffer, in characters, pointed to by the lpszErrorText parameter.

Return value

Returns TRUE if successful or FALSE if the error code is not known.

Remarks

Each string that MCI returns, whether data or an error description, can be a maximum of 128 characters.

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

mciGetErrorStringW (Unicode) and mciGetErrorStringA (ANSI)

See also

MCI

MCI Functions