blob: 6d19c104d8fbad2bd236e65ec56fd2eb295dbae8 [file] [log] [blame] [view]
# zx_vmar_destroy
## NAME
vmar_destroy - destroy a virtual memory address region
## SYNOPSIS
```
#include <zircon/syscalls.h>
zx_status_t zx_vmar_destroy(zx_handle_t vmar_handle);
```
## DESCRIPTION
**vmar_destroy**() unmaps all mappings within the given region, and destroys
all sub-regions of the region. Note that this operation is logically recursive.
This operation does not close *vmar_handle*. Any outstanding handles to this
VMAR will remain valid handles, but all VMAR operations on them will fail.
## RETURN VALUE
**vmar_destroy**() returns **ZX_OK** on success.
## ERRORS
**ZX_ERR_BAD_HANDLE** *vmar_handle* is not a valid handle.
**ZX_ERR_WRONG_TYPE** *vmar_handle* is not a VMAR handle.
**ZX_ERR_BAD_STATE** This region is already destroyed.
## NOTES
## SEE ALSO
[vmar_allocate](vmar_allocate.md),
[vmar_map](vmar_map.md),
[vmar_protect](vmar_protect.md),
[vmar_unmap](vmar_unmap.md).