MCI_SAVE command

The MCI_SAVE command saves the current file. Devices that modify files should not destroy the original copy until they receive the save message. Video-overlay and waveform-audio devices recognize this command. Although digital-video devices and MIDI sequencers also recognize this command, the MCIAVI and MCISEQ drivers do not implement it.

To send this command, call the mciSendCommand function with the following parameters.

MCIERROR mciSendCommand(
  MCIDEVICEID wDeviceID, 
  MCI_SAVE, 
  DWORD dwFlags, 
  (DWORD) (LPMCI_SAVE_PARMS ) lpSave
);

Parameters

wDeviceID

Device identifier of the MCI device that is to receive the command message.

dwFlags

MCI_NOTIFY, MCI_WAIT, or, for digital-video and VCR devices, MCI_TEST. For information about these flags, see The Wait, Notify, and Test Flags.

lpSave

Pointer to an MCI_SAVE_PARMS structure. (Devices with additional parameters might replace this structure with a device-specific structure.)

Return Value

Returns zero if successful or an error otherwise.

Remarks

This command is supported by devices that return TRUE when you call the MCI_GETDEVCAPS command with the MCI_GETDEVCAPS_CAN_SAVE flag.

The following additional flag applies to all devices supporting MCI_SAVE:

MCI_SAVE_FILE

The lpfilename member of the structure identified by lpSave contains an address of a buffer containing the destination filename.

The following additional flags are used with the digitalvideo device type:

MCI_DGV_RECT

The rc member of the structure identified by lpSave contains a valid rectangle. The rectangle specifies a region of the frame buffer that will be saved to the specified file. The first pair of coordinates specifies the upper left corner of the rectangle; the second pair specifies the width and height. Digital-video devices must use the MCI_CAPTURE command to capture the contents of the frame buffer. (Video-overlay devices should also use MCI_CAPTURE.) This flag is for compatibility with the existing MCI video-overlay command set.

MCI_DGV_SAVE_ABORT

Stops a save operation in progress. This must be the only flag present.

MCI_DGV_SAVE_KEEPRESERVE

Unused disk space left over from the original MCI_RESERVE command is not deallocated.

For digital-video devices, the lpSave parameter points to an MCI_DGV_SAVE_PARMS structure.

The following additional flag is used with the overlay device type:

MCI_OVLY_RECT

The rc member of the structure identified by lpSave contains a valid display rectangle indicating the area of the video buffer to save.

For video-overlay devices, the lpSave parameter points to an MCI_OVLY_SAVE_PARMS structure.

Requirements

See also

MCI

MCI Commands