mmpGetInfo

Syntax

BOOL mmpGetInfo(idMovie, nIndex, lpData, wLen)

This function returns internal movie data stored for the Movie Player instance. Since mmpGetInfo allows access to data structures used by the movie, improperly using the returned information can cause a general protection fault or crash the Movie Player. Do not call mmpGetInfo or change the returned data while the movie is animating.

Parameters

MMPID idMovie

Identifies the movie ID of the Movie Player instance.

int nIndex

Specifies the type of data to be returned in the memory location pointed to by the lpData parameter. Use one of the following constants:

MMPINFO_LABELLIST

Return a handle to the label-list array. Function places a handle to the array of MMPLABEL records in the memory location pointed to by lpData.

MMPINFO_LABELTEXT

Return a handle to the label-text block. Function places a handle to the label-text block in the memory location pointed to by lpData.

MMPINFO_LABELCOUNT

Return the count of label entries. Function places a WORD-sized count value in the memory location pointed to by lpData.

MMPINFO_ACTIONLIST

Return a handle to the action-list array. The action list contains the script-channel commands for the movie. Function places a handle to the array of MMPACTION records in the memory location pointed to by lpData.

MMPINFO_ACTIONTEXT

Return a handle to the action-text block. Function places a handle to the action-text block in the memory location pointed to by lpData.

MMPINFO_ACTIONCOUNT

Return the count of action entries. Function places a WORD-sized count value in the memory location pointed to by lpData.

LPVOID lpData

Specifies a far pointer to the memory area to receive the Movie Player instance data. The memory area pointed to by this parameter must be large enough to receive the requested data item.

WORD wLen

Specifies the length of the memory location pointed to by the lpData parameter.

Return Value

Returns TRUE if successful; otherwise, returns FALSE.

Comments

All handles returned by this function reference global memory objects.

For both the label and action-entry data, the three data items (label-list or action-list array, text block, and count value) are dependent on each other. When changing the label or action entry information, change all relevant data items as a single operation before yielding control. Use the mmpSetInfo command to change the memory handles or count values for the label list and action-text list.

See Also

mmpGetMovieInfo, mmpGetPaletteHandle, mmpSetInfo, MMPLABEL, MMPACTION