event_create.md

zx_event_create

NAME

event_create - create an event

SYNOPSIS

#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 plus ZX_RIGHT_SIGNAL.

RIGHTS

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()