blob: 036b537831d7101918b8b8a86b9b58ee5027c85e [file] [log] [blame] [view]
# zx_event_create
## NAME
<!-- Updated by update-docs-from-abigen, do not edit. -->
Create an event.
## SYNOPSIS
<!-- Updated by update-docs-from-abigen, do not edit. -->
```c
#include <zircon/syscalls.h>
zx_status_t zx_event_create(uint32_t options, zx_handle_t* out);
```
## DESCRIPTION
`zx_event_create()` creates an event, which is an object that is signalable. That
is, its **ZX_USER_SIGNAL_n** (where *n* is 0 through 7) signals can be
manipulated using [`zx_object_signal()`].
The newly-created handle will have the [basic
rights](/docs/concepts/kernel/rights.md#zx_rights_basic) plus **ZX_RIGHT_SIGNAL**.
## RIGHTS
<!-- Updated by update-docs-from-abigen, do not edit. -->
TODO(ZX-2399)
## RETURN VALUE
`zx_event_create()` returns **ZX_OK** and a valid event handle (via *out*) on success.
On failure, an error value is returned.
## ERRORS
**ZX_ERR_INVALID_ARGS** *out* is an invalid pointer, or *options* is nonzero.
**ZX_ERR_NO_MEMORY** Failure due to lack of memory.
There is no good way for userspace to handle this (unlikely) error.
In a future build this error will no longer occur.
## SEE ALSO
- [`zx_eventpair_create()`]
- [`zx_handle_close()`]
- [`zx_handle_duplicate()`]
- [`zx_handle_replace()`]
- [`zx_object_signal()`]
- [`zx_object_wait_async()`]
- [`zx_object_wait_many()`]
- [`zx_object_wait_one()`]
<!-- References updated by update-docs-from-abigen, do not edit. -->
[`zx_eventpair_create()`]: eventpair_create.md
[`zx_handle_close()`]: handle_close.md
[`zx_handle_duplicate()`]: handle_duplicate.md
[`zx_handle_replace()`]: handle_replace.md
[`zx_object_signal()`]: object_signal.md
[`zx_object_wait_async()`]: object_wait_async.md
[`zx_object_wait_many()`]: object_wait_many.md
[`zx_object_wait_one()`]: object_wait_one.md