This message causes a video device to transfer an image from the element buffer to the display surface. To ensure that the image is displayed, the device automatically performs a freeze operation where necessary.

ulParam1 (ULONG)

This parameter can contain any of the following flags:

MCI_NOTIFY

A notification message will be posted to the window specified in the hwndCallback parameter of the data structure pointed to by the pParam2 parameter. The notification will be posted when the action indicated by this message is completed or when an error occurs.
MCI_WAIT
Control is not to be returned until the action indicated by this message is completed or an error occurs.
MCI_RESTORE_SRC_RECT
The SrcRect field of the MCI_RESTORE_PARMS data structure contains a rectangle specifying the area to be restored from the capture device element. If this flag is not specified, the entire image is restored.
MCI_RESTORE_DEST_RECT
The DestRect field of the MCI_RESTORE_PARMS data structure contains a rectangle specifying the destination area of the window to be restored. If this flag is not specified, the destination size is assumed to be the same as the image size in device coordinates placed at the lower-left corner of the window.

pParam2 (PMCI_RESTORE_PARMS)

A pointer to an MCI_RESTORE_PARMS data structure.

rc (ULONG)

This function fails if nothing is currently in the capture device element.

Return codes indicating success or type of failure:

MCIERR_SUCCESS

MMPM/2 command completed successfully.
MCIERR_OUT_OF_MEMORY
System out of memory.
MCIERR_INVALID_DEVICE_ID
Invalid device ID given.
MCIERR_MISSING_PARAMETER
Missing parameter for this command.
MCIERR_DRIVER
Internal MMPM/2 driver error.
MCIERR_INVALID_FLAG
Invalid flag specified for this command.
MCIERR_UNSUPPORTED_FLAG
Flag not supported by this MMPM/2 driver for this command.
MCIERR_INSTANCE_INACTIVE
The device is currently inactive.
MCIERR_OVLY_INVALID_RECT
An invalid rectangle was specified.
MCIERR_OVLY_NOT_AVAILABLE
The requested action is not available. (For example, video has been set off.)

---

[Back] [Next]