1# zx_vcpu_interrupt
2
3## NAME
4
5<!-- Updated by update-docs-from-abigen, do not edit. -->
6
7vcpu_interrupt - raise an interrupt on a VCPU
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_vcpu_interrupt(zx_handle_t handle, uint32_t vector);
17```
18
19## DESCRIPTION
20
21`zx_vcpu_interrupt()` raises an interrupt of *vector* on *handle*, and may be
22called from any thread.
23
24## RIGHTS
25
26<!-- Updated by update-docs-from-abigen, do not edit. -->
27
28*handle* must be of type **ZX_OBJ_TYPE_VCPU** and have **ZX_RIGHT_SIGNAL**.
29
30## RETURN VALUE
31
32`zx_vcpu_interrupt()` returns **ZX_OK** on success. On failure, an error value is
33returned.
34
35## ERRORS
36
37**ZX_ERR_ACCESS_DENIED** *handle* does not have the **ZX_RIGHT_SIGNAL** right.
38
39**ZX_ERR_BAD_HANDLE** *handle* is an invalid handle.
40
41**ZX_ERR_OUT_OF_RANGE** *vector* is outside of the range interrupts supported by
42the current architecture.
43
44**ZX_ERR_WRONG_TYPE** *handle* is not a handle to a VCPU.
45
46## SEE ALSO
47
48 - [`zx_guest_create()`]
49 - [`zx_guest_set_trap()`]
50 - [`zx_vcpu_create()`]
51 - [`zx_vcpu_read_state()`]
52 - [`zx_vcpu_resume()`]
53 - [`zx_vcpu_write_state()`]
54
55<!-- References updated by update-docs-from-abigen, do not edit. -->
56
57[`zx_guest_create()`]: guest_create.md
58[`zx_guest_set_trap()`]: guest_set_trap.md
59[`zx_vcpu_create()`]: vcpu_create.md
60[`zx_vcpu_read_state()`]: vcpu_read_state.md
61[`zx_vcpu_resume()`]: vcpu_resume.md
62[`zx_vcpu_write_state()`]: vcpu_write_state.md
63