> ## 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.

# GetPurposes

> Returns the LampPurposes flags describing what a Lamp on a LampArray is intended for, such as Control, Accent, Branding, Status, or Illumination.

Returns the set of purposes for which the Lamp is intended to be used.

## Syntax

```cpp theme={null}
LampPurposes GetPurposes(
)
```

### Parameters

This method has no parameters.

### Return value

Type: [LampPurposes](https://docs.xbox.com/reference/lighting/lamparray/enums/lamppurposes.md)

A set of flags indicating the purposes for which the Lamp is intended to be used.

## 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)\
[ILampInfo](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilampinfo/ilampinfo.md)


## Related topics

- [LampPurposes Enumeration](https://docs.xbox.com/reference/lighting/lamparray/enums/lamppurposes.md)
- [ILampInfo (Interface contents)](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilampinfo/ilampinfo.md)
- [GetIndicesForPurposes](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getindicesforpurposes.md)
- [GetIndicesCountForPurposes](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getindicescountforpurposes.md)
- [GetLampInfo](https://docs.xbox.com/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlampinfo.md)