Edit

Share via

restore command

  • Article

The restore command copies a still image from a file to the frame buffer. This is the reverse of the capture command. Digital-video devices recognize this command.

To send this command, call the mciSendString function with the lpszCommand parameter set as follows.

_stprintf_s(
  lpszCommand, 
  TEXT("restore %s %s %s"), 
  lpszDeviceID, 
  lpszRestore, 
  lpszFlags
);

Parameters

lpszDeviceID

Identifier of an MCI device. This identifier or alias is assigned when the device is opened.

lpszRestore

One or more of the following flags.

Value Meaning
at rectangle Specifies a rectangle relative to the frame buffer origin. The rectangle is specified as X1 Y1 X2 Y2. The coordinates X1 Y1 specify the upper left corner and the coordinates X2 Y2 specify the width and height.If this flag is not used, the image is copied to the upper left corner of the frame buffer.
from filename Specifies the image filename to recall. This flag is required.

lpszFlags

Can be "wait", "notify", "test", or a combination of these. For more information about these flags, see The Wait, Notify, and Test Flags.

Return Value

Returns zero if successful or an error otherwise.

Remarks

Devices can recognize a variety of image formats; a Windows device-independent bitmap is always recognized.

Requirements

Requirement Value
Minimum supported client
 Windows 2000 Professional [desktop apps only]
Minimum supported server
 Windows 2000 Server [desktop apps only]

See also

MCI

MCI Command Strings

capture