Contents

# Index inspection functions

## h3GetResolution

```
int h3GetResolution(H3Index h);
```

Returns the resolution of the index.

## h3GetBaseCell

```
int h3GetBaseCell(H3Index h);
```

Returns the base cell number of the index.

## stringToH3

```
H3Index stringToH3(const char *str);
```

Converts the string representation to `H3Index` (`uint64_t`) representation.

Returns 0 on error.

## h3ToString

```
void h3ToString(H3Index h, char *str, size_t sz);
```

Converts the `H3Index` representation of the index to the string representation. `str` must be at least of length 17.

## h3IsValid

```
int h3IsValid(H3Index h);
```

Returns non-zero if this is a valid **H3** index.

## h3IsResClassIII

```
int h3IsResClassIII(H3Index h);
```

Returns non-zero if this index has a resolution with Class III orientation.

## h3IsPentagon

```
int h3IsPentagon(H3Index h);
```

Returns non-zero if this index represents a pentagonal cell.

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
h3-3.4.4	ext/h3/src/docs/api/inspection.md
h3-3.4.0	ext/h3/src/docs/api/inspection.md
h3-3.3.1	ext/h3/src/docs/api/inspection.md