Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 1.5 KB

vmo_write.md

File metadata and controls

61 lines (37 loc) · 1.5 KB

zx_vmo_write

NAME

vmo_write - write bytes to the VMO

SYNOPSIS

#include <zircon/syscalls.h>

zx_status_t zx_vmo_write(zx_handle_t handle, const void* buffer,
                         uint64_t offset, size_t buffer_size);

DESCRIPTION

vmo_write() attempts to write exactly buffer_size bytes to a VMO at offset.

buffer pointer to a user buffer to write bytes from.

buffer_size number of bytes to attempt to write.

RIGHTS

TODO(ZX-2399)

RETURN VALUE

zx_vmo_write() returns ZX_OK on success, and exactly buffer_size bytes will have been written from buffer. In the event of failure, a negative error value is returned, and the number of bytes written from buffer is undefined.

ERRORS

ZX_ERR_BAD_HANDLE handle is not a valid handle.

ZX_ERR_WRONG_TYPE handle is not a VMO handle.

ZX_ERR_ACCESS_DENIED handle does not have the ZX_RIGHT_WRITE right.

ZX_ERR_INVALID_ARGS buffer is an invalid pointer or NULL.

ZX_ERR_NO_MEMORY Failure to allocate system memory to complete write.

ZX_ERR_OUT_OF_RANGE offset starts at or beyond the end of the VMO, or VMO is shorter than buffer_size.

ZX_ERR_BAD_STATE VMO has been marked uncached and is not directly writable.

SEE ALSO

vmo_create, vmo_clone, vmo_read, vmo_get_size, vmo_set_size, vmo_op_range. vmo_set_cache_policy