mciGetErrorString

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

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

Parameters

fdwError

Error code returned by the mciSendCommand or mciSendString function.

lpszErrorText

Address of 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 Values

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.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in mmsystem.h.
  Import Library: Use winmm.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

MCI Overview, MCI Functions, mciSendCommand, mciSendString