MCI_RESTORE

This MCI command message copies a bitmap from a file to the frame buffer. This the reverse of MCI_CAPTURE. The implementation may recognize a variety of image formats but a Windows DIB is always accepted.

Parameters

DWORD lParam1

The following flags apply to all devices supporting MCI_RESTORE:


MCI_NOTIFY

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

MCI_TEST

Queries the device to determine if it can execute the command. The device returns an error if it is incapable of executing the command. It returns no error if it can handle the command. MCI returns control to the application without executing the command.

MCI_WAIT

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

MCI_DGV_RESTORE_FROM

Indicates the lpstrFileName field of the data structure identified by lParam2 contains a pointer to a buffer containing the destination filename. The filename is required.

MCI_DGV_RESTORE_AT

Specifies that the rc field of the data structure identified by lParam2 contains a valid rectangle. The rectangle specifies a region of the frame buffer relative to its origin. The first pair of coordinates specify the upper-left corner of the rectangle and the second pair of coordinates specify the width and height of the rectangle. If this flag is not specified, the image is copied to the upper-left corner of the frame buffer.

LPMCI_DGV_RESTORE_PARMS lParam2

Specifies a far pointer to the MCI_DGV_RESTORE_PARMS data structure.

Return Value

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

See Also

MCI_CAPTURE