main/syscalls/clock_get_boot.md

<!--
Copyright 2023 The Fuchsia Authors. All rights reserved.
Use of this source code is governed by a BSD-style license that can be
found in the LICENSE file.

DO NOT EDIT. Generated from FIDL library zx by zither, a Fuchsia platform tool.

See //docs/reference/syscalls/README.md#documentation-generation for
regeneration instructions.
-->

# zx_clock_get_boot

## Summary

Acquire the current boot time.

## Declaration

```c
#include <zircon/syscalls.h>

zx_instant_boot_t zx_clock_get_boot(void);
```

## Description

`zx_clock_get_boot()` returns the current time in the system
boot clock. This is the number of nanoseconds since the system was
powered on, including any time spent in a suspended state. It is set to
zero whenever the kernel is initialized.

## Rights

None.

## Return value

`zx_clock_get_boot()` returns the current boot time.

## Errors

`zx_clock_get_boot()` cannot fail.