MCI_INDEX

The MCI_INDEX command turns the on-screen display on or off. VCR devices recognize this command.

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

MCIERROR mciSendCommand(
  MCIDEVICEID wDeviceID, 
  MCI_INDEX, 
  DWORD dwFlags, 
  (DWORD) (LPMCI_GENERIC_PARMS) lpIndex
);

Parameters

wDeviceID

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

dwFlags

MCI_NOTIFY, MCI_WAIT, or MCI_TEST. For information about these flags, see The Wait, Notify, and Test Flags.

lpIndex

Pointer to an MCI_GENERIC_PARMS structure. (Devices with extended command sets might replace this structure with a device-specific structure.)

Return Values

Returns zero if successful or an error otherwise.

Remarks

The information presented in the on-screen display is controlled by the MCI_VCR_SET_INDEX flag in the MCI_SET command.

The following additional flags apply to VCR devices:

MCI_SET_OFF

Turns on-screen display off.

MCI_SET_ON

Turns on-screen display on.

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_GENERIC_PARMS, MCI_SET

Show: