LampArrayEffectPlaylist.IndexOf(ILampArrayEffect, UInt32) Method

Reference

Definition

Namespace:: Windows.Devices.Lights.Effects

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.

Edit

Retrieves the index, within a playlist, of the specified lamp array effect.

public:
 virtual bool IndexOf(ILampArrayEffect ^ value, [Out] unsigned int & index) = IVectorView<ILampArrayEffect ^>::IndexOf;

bool IndexOf(ILampArrayEffect const& value, [Out] uint32_t & index);

public bool IndexOf(ILampArrayEffect value, out uint index);

Public Function IndexOf (value As ILampArrayEffect, ByRef index As UInteger) As Boolean

Parameters

value: ILampArrayEffect

An ILampArrayEffect representing the lamp array effect whose index to retrieve.

index: UInt32
unsigned int

uint32_t

The index of the effect within the playlist, as an out parameter. If the value is found, then the method will update index with the zero-based index of the effect within the playlist.

Returns

Boolean

bool

true if the effect is found, otherwise false.

Implements

M:Windows.Foundation.Collections.IVectorView1.IndexOf(0,System.UInt32@) M:Windows.Foundation.Collections.IVectorView1.IndexOf(0,unsigned int@) M:Windows.Foundation.Collections.IVectorView1.IndexOf(0,uint32_t@)

Examples

LampArray sample

Demonstrates how to control RGB lighting of peripheral devices using the Windows.Devices.Lights and Windows.Devices.Lights.Effects APIs.

AutoRGB Sample

Demonstrates how to extract a single, representative color from a desktop screen and use it to illuminate LED lamps on a connected RGB device.

Applies to