index command

The index command controls a VCR's on-screen display. VCR devices recognize this command.

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

_stprintf_s(
  lpszCommand, 
  TEXT("index %s %s %s"), 
  lpszDeviceID, 
  lpszIndex, 
  lpszFlags
); 

Parameters

lpszDeviceID

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

lpszIndex

One of the following flags.

Value	Meaning
off	Turns off the on-screen display.
on	Turns on the on-screen display. The item to be displayed is specified by the "index" flag of the set command.

lpszFlags

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

Return Value

Returns zero if successful or an error otherwise.

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

set