# Settlement IdxToSet(int)

[Family: Global](/imperivm/en/CKS/familias/global/)

## Exact signature

```text
Settlement IdxToSet(int)
```

## Description

IdxToSet returns the handle ID from an indexed global-map settlement pointer, or a null handle for an invalid or empty slot.

## Parameters and return type

**Return type:** `Settlement`

| Position | Type |
| --- | --- |
| 1 | `int` |

## Read and share

- [Markdown](/imperivm/exports/en/cks/api-26a63bd6803875.md)
- [JSON](/imperivm/CKS/api/entries/api-26a63bd6803875?lang=en)

Keep the notes and limitations when reusing this description. Do not infer undocumented parameter meanings, units or effects.