blob: 051003c7ce8983c2f7f2e7e7feba0489bdc354b0 [file] [log] [blame] [view]
# zx_clock_read
## NAME
<!-- Updated by update-docs-from-fidl, do not edit. -->
Perform a basic read of the clock.
## SYNOPSIS
<!-- Updated by update-docs-from-fidl, do not edit. -->
```c
#include <zircon/syscalls.h>
zx_status_t zx_clock_read(zx_handle_t handle, zx_time_t* now);
```
## RIGHTS
<!-- Updated by update-docs-from-fidl, do not edit. -->
*handle* must be of type **ZX_OBJ_TYPE_CLOCK** and have **ZX_RIGHT_READ**.
## DESCRIPTION
Perform a basic read of the clock object and return its current time in the
*now* out parameter.
## RETURN VALUE
On success, returns **ZX_OK** along with the clock's current time in the *now* output parameter.
## ERRORS
- **ZX_ERR_BAD_HANDLE** : *handle* is either an invalid handle, or a handle to
an object type which is not **ZX_OBJ_TYPE_CLOCK**.
- **ZX_ERR_ACCESS_DENIED** : *handle* lacks the **ZX_RIGHT_READ** right.
- **ZX_ERR_BAD_STATE** : The clock object has never been updated. No initial
time has been established yet.
## SEE ALSO
- [clocks](/docs/reference/kernel_objects/clock.md)
- [`zx_clock_create()`]
- [`zx_clock_get_details()`]
- [`zx_clock_update()`]
<!-- References updated by update-docs-from-fidl, do not edit. -->
[`zx_clock_create()`]: clock_create.md
[`zx_clock_get_details()`]: clock_get_details.md
[`zx_clock_update()`]: clock_update.md