Share via

IMediaCenterInputKeyMap::UIModeKeyMap Method

  • Article

Provides the shell with the strings to display on the on-screen keypad.

Note   This method has been deprecated.

Syntax

  HRESULT UIModeKeyMap(
  INT  iMode,
  BSTRARRAY*  pKeyMap
);

Parameters

iMode

[in] Integer containing the index of the key map being requested.

pKeyMap

[out] Pointer to an array of twelve BSTR strings that the shell uses to display on each of the keys of the on-screen keypad.

Return Value

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Remarks

The on-screen keypad consists of four rows of three keys. The shell uses the first three strings in the pKeyMap array to create the first row, from left to right. It uses the second three values to create the second row, also from left to right; and so on. Empty strings indicate a blank entry for the corresponding key.

Requirements

Header: ehinputmodule.idl

Platform: Windows XP Media Center Edition 2004 through Windows Vista

See Also