mmpError

Syntax

int mmpError(idMovie, lpszErrorString, wLen)

This function returns the status of a Movie Player instance and optionally fills a character buffer with a descriptive error message. The error code reflects the status of the movie following the previous Movie Player API call.

Parameters

MMPID idMovie

Identifies the movie ID of the Movie Player instance. Pass a NULL value to this parameter to retrieve error information about the last Movie Player API call for all instances.

LPSTR lpszErrorString

Pointer to an error message buffer. If this pointer is not NULL, the buffer is filled with a descriptive error message. If you pass a NULL pointer, no error message string is copied.

WORD wLen

Specifies the length of the buffer referenced by the lpszErrorString parameter. The maximum message length is specified by the constant MMP_MAXERRORLENGTH.

Return Value

Returns one of the following codes, which identify the last error that occurred:

MMPERR_NO_ERROR

Indicates no error occurred.

MMPERR_FATAL_ERROR

Indicates that a fatal error occurred.

MMPERR_STAGE_ERROR

Indicates an error occurred while creating the stage window.

MMPERR_FILE_VER

Indicates the movie file version is incompatible with the Movie Player.

MMPERR_FILE_TYPE

Indicates the file is not a RIFF RMMP movie file.

MMPERR_OPEN_ERROR

Indicates a DOS error occurred while trying to open the file.

MMPERR_READ_ERROR

Indicates a DOS error occurred while trying to read from the file.

MMPERR_EOF_ERROR

Indicates the Movie Player encountered an unexpected end-of-file.

MMPERR_REC_HEADER

Indicates an error in the file record header.

MMPERR_CAST_ERROR

Indicates an error occurred while trying to read a cast member.

MMPERR_CAST_MAP_ERROR

Indicates a cast-list mapping mismatch.

MMPERR_MEM_ALLOC

Indicates insufficient memory to complete the operation.

MMERR_BAD_PARM

Indicates a bad or missing parameter passed to the Movie Player function.

MMPERR_BAD_ID

Indicates an incorrect movie ID was used when calling a Movie Player function from a frame-hook function.

Comments

After receiving an error return value from a Movie Player function, you should call mmpError to retrieve a specific error code and optional error text string.