zx_vmo_read

NAME

vmo_read - read bytes from the VMO

SYNOPSIS

#include <zircon/syscalls.h>

zx_status_t zx_vmo_read(zx_handle_t handle, void* data, uint64_t offset, size_t len,
                        size_t* actual);

DESCRIPTION

vmo_read() attempts to read len bytes from a VMO at offset. The number of actual bytes read is returned in actual.

data pointer to a user buffer to read bytes into.

len number of bytes to attempt to read. data buffer should be large enough for at least this many bytes.

actual returns the actual number of bytes read, which may be anywhere from 0 to len. If a read extends beyond the size of the VMO, the actual bytes read will be trimmed. If the read starts at or beyond the size of the VMO, ZX_ERR_OUT_OF_RANGE will be returned.

RETURN VALUE

zx_vmo_read() returns ZX_OK on success. In the event of failure, a negative error value is returned.

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_READ right.

ZX_ERR_INVALID_ARGS actual or data is an invalid pointer or NULL.