# int SetToIdx(Settlement)

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

## Exact signature

```text
int SetToIdx(Settlement)
```

## Description

SetToIdx reads the resolved Settlement slot-index field.

## Parameters and return type

**Return type:** `int`

| Position | Type |
| --- | --- |
| 1 | `Settlement` |

## Read and share

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

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