> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GetLampInfo

> Returns an ILampInfo object describing an individual Lamp on a LampArray by index, exposing position, color support, purposes, and scan code.

Returns an ILampInfo for the Lamp at the given index.

## Syntax

```cpp theme={null}
HRESULT GetLampInfo(
    uint32_t lampIndex,
    ILampInfo** lampInfo)
```

### Parameters

*lampIndex*\
Type: uint32\_t

The desired index in the ILampArray for which to obtain an ILampInfo.

*lampInfo*  \_COM\_Outptr\_\
Type: ILampInfo\*\*

The ILampInfo corresponding to lampIndex. This will be null if lampIndex is greater than or equal to [ILampArray::GetLampCount](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlampcount.md);

### Return value

Type: HRESULT

Function result.

## Remarks

The [ILampInfo](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilampinfo/ilampinfo.md) contains properties about a Lamp at a given index in the ILampArray.

## Requirements

**Header:** LampArray.h

**Library:** xgameplatform.lib

**Supported platforms:** XBOX One family consoles and XBOX Series consoles

## See also

[Lighting API Overview](https://docs.xbox.com/build/core-features/common/lighting/gc-lighting-toc.md)\
[ILampArray](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilamparray/ilamparray.md)\
[ILampInfo](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilampinfo/ilampinfo.md)


## Related topics

- [GetIndex](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilampinfo/methods/ilampinfo_getindex.md)
- [LampArray Basics](https://docs.xbox.com/build/core-features/common/lighting/lighting-basics.md)
- [ILampArray (Interface contents)](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilamparray/ilamparray.md)
- [ILampInfo (Interface contents)](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilampinfo/ilampinfo.md)
- [LampPurposes Enumeration](https://docs.xbox.com/reference/lighting/lamparray/enums/lamppurposes.md)