MCI_LOAD

  • Article

The MCI_LOAD command loads a file. Digital-video and video-overlay devices recognize this command.

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

MCIERROR mciSendCommand(
  MCIDEVICEID wDeviceID, 
  MCI_LOAD, 
  DWORD dwFlags, 
  (DWORD) (LPMCI_LOAD_PARMS) lpLoad
);

Parameters

wDeviceID

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

dwFlags

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

lpLoad

Pointer to an MCI_LOAD_PARMS structure. (Devices with additional parameters might replace this structure with a device-specific structure. For digital-video devices, the lpLoad parameter points to an MCI_DGV_LOAD_PARMS structure.)

Return Values

Returns zero if successful or an error otherwise.

Remarks

The following additional flag applies to all devices supporting MCI_LOAD:

MCI_LOAD_FILE

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

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

MCI_OVLY_RECT

The rc member of the structure identified by lpLoad contains a valid display rectangle that identifies the area of the video buffer to update.

For video-overlay devices, the lpLoad parameter points to an MCI_OVLY_LOAD_PARMS structure.

Requirements

**  Windows NT/2000/XP:** Included in Windows NT 3.1 and later.
**  Windows 95/98/Me:** Included in Windows 95 and later.
**  Header:** Declared in Mmsystem.h; include Windows.h.

See Also

MCI, MCI Commands, MCI_DGV_LOAD_PARMS, MCI_LOAD_PARMS, MCI_OVLY_LOAD_PARMS