1# zx_vmo_get_size
2
3## NAME
4
5<!-- Updated by update-docs-from-abigen, do not edit. -->
6
7vmo_get_size - read the current size of a VMO 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_vmo_get_size(zx_handle_t handle, uint64_t* size);
17```
18
19## DESCRIPTION
20
21`zx_vmo_get_size()` returns the current size of the VMO.
22
23## RIGHTS
24
25<!-- Updated by update-docs-from-abigen, do not edit. -->
26
27TODO(ZX-2399)
28
29## RETURN VALUE
30
31`zx_vmo_get_size()` returns **ZX_OK** on success. In the event
32of failure, a negative error value is returned.
33
34## ERRORS
35
36**ZX_ERR_BAD_HANDLE**  *handle* is not a valid handle.
37
38**ZX_ERR_WRONG_TYPE**  *handle* is not a VMO handle.
39
40**ZX_ERR_INVALID_ARGS**  *size* is an invalid pointer or NULL.
41
42## SEE ALSO
43
44 - [`zx_vmo_clone()`]
45 - [`zx_vmo_create()`]
46 - [`zx_vmo_op_range()`]
47 - [`zx_vmo_read()`]
48 - [`zx_vmo_set_size()`]
49 - [`zx_vmo_write()`]
50
51<!-- References updated by update-docs-from-abigen, do not edit. -->
52
53[`zx_vmo_clone()`]: vmo_clone.md
54[`zx_vmo_create()`]: vmo_create.md
55[`zx_vmo_op_range()`]: vmo_op_range.md
56[`zx_vmo_read()`]: vmo_read.md
57[`zx_vmo_set_size()`]: vmo_set_size.md
58[`zx_vmo_write()`]: vmo_write.md
59