MCI_WHERE (ANIMATION/VIDEO OVERLAY)

This MCI command message obtains the clipping rectangle for the video device. The top and left fields of the returned rectangle contain the origin of the clipping rectangle, and the right and bottom fields contain the width and height of the clipping rectangle. The parameters and flags for this message vary according to the selected device.

Parameters

DWORD lParam1

The following flags apply to all devices supporting MCI_WHERE:

MCI_NOTIFY

Specifies that MCI should post the MM_MCINOTIFY message when this command completes. The window to receive this message is specified in the dwCallback field of the data structure identified by lpQuery.

MCI_WAIT

Specifies that the operation should complete before MCI returns control to the application.

DWORD lpQuery

Specifies a far pointer to a device-specific data structure. For a description of this parameter, see the lpQuery description included with the device extensions.

Animation Extensions

DWORD lParam1

The following additional flags apply to animation devices supporting MCI_WHERE:

MCI_ANIM_WHERE_DESTINATION

Obtains the destination display rectangle. The rectangle coordinates are placed in the rc field of the data structure identified by lpQuery.

MCI_ANIM_WHERE_SOURCE

Obtains the animation source rectangle. The rectangle coordinates are placed in the rc field of the data structure identified by lpQuery.

LPMCI_ANIM_RECT_PARMS lParam2

Specifies a far pointer to a MCI_ANIM_RECT_PARMS data structure.

Video Overlay Extensions

DWORD lParam1

The following additional flags apply to video overlay devices supporting MCI_WHERE:

MCI_OVLY_WHERE_DESTINATION

Obtains the destination display rectangle. The rectangle coordinates are placed in the rc field of the data structure identified by lParam2.

MCI_OVLY_WHERE_FRAME

Obtains the overlay frame rectangle. The rectangle coordinates are placed in the rc field of the data structure identified by lParam2.

MCI_OVLY_WHERE_SOURCE

Obtains the source rectangle. The rectangle coordinates are placed in the rc field of the data structure identified by lParam2.

MCI_OVLY_WHERE_VIDEO

Obtains the video rectangle. The rectangle coordinates are placed in the rc field of the data structure identified by lParam2.

LPMCI_OVLY_RECT_PARMS lParam2

Specifies a far pointer to a MCI_OVLY_RECT_PARMS data structure.

Return Value

Returns zero if successful. Otherwise, it returns an MCI error code.

Comments

This command applies to animation and video overlay devices.