Skip to content

Latest commit

 

History

History
54 lines (32 loc) · 1.29 KB

fifo_write.md

File metadata and controls

54 lines (32 loc) · 1.29 KB

zx_fifo_write

NAME

fifo_write - write data to a fifo

SYNOPSIS

#include <zircon/syscalls.h>

zx_status_t zx_fifo_write(zx_handle_t handle,
                          const void* buffer, size_t size,
                          uint32_t* num_entries_written) {

DESCRIPTION

fifo_write() attempts to write some number of elements into the fifo specified by handle. size will be rounded down to a multiple of the fifo's element-size.

It is not legal to write zero elements.

Fewer elements may be written than requested if there is insufficient room in the fifo to contain all of them.

RETURN VALUE

fifo_write() returns ZX_OK on success, and returns the number of elements written (at least one) via num_entries_written.

ERRORS

ZX_ERR_BAD_HANDLE handle is not a valid handle.

ZX_ERR_WRONG_TYPE handle is not a fifo handle.

ZX_ERR_INVALID_ARGS buffer is an invalid pointer or num_entries_written is an invalid pointer.

ZX_ERR_OUT_OF_RANGE size was smaller than the size of a single element.

ZX_ERR_ACCESS_DENIED handle does not have ZX_RIGHT_WRITE.

ZX_ERR_PEER_CLOSED The other side of the fifo is closed.

ZX_ERR_SHOULD_WAIT The fifo is full.

SEE ALSO

fifo_create, fifo_read.