1# zx_interrupt_trigger 2 3## NAME 4 5<!-- Updated by update-docs-from-abigen, do not edit. --> 6 7interrupt_trigger - triggers a virtual interrupt object 8 9## SYNOPSIS 10 11<!-- Updated by update-docs-from-abigen, do not edit. --> 12 13``` 14#include <zircon/syscalls.h> 15 16zx_status_t zx_interrupt_trigger(zx_handle_t handle, 17 uint32_t options, 18 zx_time_t timestamp); 19``` 20 21## DESCRIPTION 22 23`zx_interrupt_trigger()` is used to trigger a virtual interrupt interrupt object, 24causing an interrupt message packet to arrive on the bound port, if it is bound 25to a port, or [`zx_interrupt_wait()`] to return if it is waiting on this interrupt. 26 27*options* must be zero. 28 29## RIGHTS 30 31<!-- Updated by update-docs-from-abigen, do not edit. --> 32 33*handle* must be of type **ZX_OBJ_TYPE_INTERRUPT** and have **ZX_RIGHT_SIGNAL**. 34 35## RETURN VALUE 36 37`zx_interrupt_trigger()` returns **ZX_OK** on success. In the event 38of failure, a negative error value is returned. 39 40## ERRORS 41 42**ZX_ERR_BAD_HANDLE** *handle* is an invalid handle. 43 44**ZX_ERR_WRONG_TYPE** *handle* is not an interrupt object. 45 46**ZX_ERR_BAD_STATE** *handle* is not a virtual interrupt. 47 48**ZX_ERR_CANCELED** [`zx_interrupt_destroy()`] was called on *handle*. 49 50**ZX_ERR_ACCESS_DENIED** *handle* lacks **ZX_RIGHT_SIGNAL**. 51 52**ZX_ERR_INVALID_ARGS** *options* is non-zero. 53 54## SEE ALSO 55 56 - [`zx_handle_close()`] 57 - [`zx_interrupt_ack()`] 58 - [`zx_interrupt_bind()`] 59 - [`zx_interrupt_create()`] 60 - [`zx_interrupt_destroy()`] 61 - [`zx_interrupt_wait()`] 62 - [`zx_port_wait()`] 63 64<!-- References updated by update-docs-from-abigen, do not edit. --> 65 66[`zx_handle_close()`]: handle_close.md 67[`zx_interrupt_ack()`]: interrupt_ack.md 68[`zx_interrupt_bind()`]: interrupt_bind.md 69[`zx_interrupt_create()`]: interrupt_create.md 70[`zx_interrupt_destroy()`]: interrupt_destroy.md 71[`zx_interrupt_wait()`]: interrupt_wait.md 72[`zx_port_wait()`]: port_wait.md 73