MCI_PUT

This MCI command message sets the source, destination, and frame rectangles. 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_PUT:

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 lpDest.

MCI_WAIT

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

LPMCI_GENERIC_PARMS lParam2

Specifies a far pointer to an MCI_GENERIC_PARMS data structure. (Devices with extended command sets might replace this data structure with a device-specific data structure.)

Animation Extensions

DWORD lParam1

The following additional flags apply to animation devices supporting MCI_PUT:

MCI_ANIM_RECT

Specifies that the rc field of the data structure identified by lParam2 contains a valid rectangle. If this flag is not specified, the default rectangle matches the coordinates of the image or window being clipped.

MCI_ANIM_PUT_DESTINATION

Indicates the rectangle defined for MCI_ANIM_RECT specifies the area of the client window used to display an image. The rectangle contains the offset and visible extent of the image relative to the window origin. If the frame is being stretched, the source is stretched to the destination rectangle.

MCI_ANIM_PUT_SOURCE

Indicates the rectangle defined for MCI_ANIM_RECT specifies a clipping rectangle for the animation image. The rectangle contains the offset and extent of the image relative to the image origin.

LPMCI_ANIM_RECT_PARMS lParam2

Specifies a far pointer to a MCI_ANIM_RECT_PARMS data structure. (Devices with extended command sets might replace this data structure with a device-specific data structure.)

Video Overlay Extensions

DWORD lParam1

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

MCI_OVLY_RECT

Specifies that the rc field of the data structure identified by lParam2 contains a valid display rectangle. If this flag is not specified, the default rectangle matches the coordinates of the video buffer or window being clipped.

MCI_OVLY_PUT_DESTINATION

Indicates the rectangle defined for MCI_OVLY_RECT specifies the area of the client window used to display an image. The rectangle contains the offset and visible extent of the image relative to the window origin. If the frame is being stretched, the source is stretched to the destination rectangle.

MCI_OVLY_PUT_FRAME

Indicates the rectangle defined for MCI_OVLY_RECT specifies the area of the video buffer used to receive the video image. The rectangle contains the offset and extent of the buffer area relative to the video buffer origin.

MCI_OVLY_PUT_SOURCE

Indicates that the rectangle defined for MCI_OVLY_RECT specifies the area of the video buffer used as the source of the digital image. The rectangle contains the offset and extent of the clipping rectangle for the video buffer relative to its origin.

MCI_OVLY_PUT_VIDEO

Indicates that the rectangle defined for MCI_OVLY_RECT specifies the area of the video source capture by the video buffer. The rectangle contains the offset and extent of the clipping rectangle for the video source relative to its origin.

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.

See Also

MCI_WHERE