LampArray.GetIndicesForKey(VirtualKey) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Searches for all lamp indices that are bound to the specific VirtualKey
public:
virtual Platform::Array <int> ^ GetIndicesForKey(VirtualKey key) = GetIndicesForKey;
winrt::array_view <int> GetIndicesForKey(VirtualKey const& key);
public int[] GetIndicesForKey(VirtualKey key);
function getIndicesForKey(key)
Public Function GetIndicesForKey (key As VirtualKey) As Integer()
Parameters
- key
- VirtualKey
The VirtualKey.
Returns
Int32[]
int[]
Array of all lamp indices that are bound to the specific VirtualKey. Array is empty if no lamp indices are found bound to the VirtualKey.
Examples
Demonstrates how to control RGB lighting of peripheral devices using the Windows.Devices.Lights and Windows.Devices.Lights.Effects APIs.
Demonstrates how to extract a single, representative color from a desktop screen and use it to illuminate LED lamps on a connected RGB device.
Remarks
Lamp indices can be (optionally) bound by the device to only a single key. A VirtualKey may have 1 or more indices bound to it.