Skip to content

Latest commit

 

History

History
93 lines (60 loc) · 2.97 KB

stream_writev_at.md

File metadata and controls

93 lines (60 loc) · 2.97 KB
Raw

zx_stream_writev_at

SUMMARY

Write data to a stream at the given offset.

DECLARATION

#include <zircon/syscalls.h>

zx_status_t zx_stream_writev_at(zx_handle_t handle,
                                uint32_t options,
                                zx_off_t offset,
                                const zx_iovec_t* vector,
                                size_t num_vector,
                                size_t* actual);

DESCRIPTION

zx_stream_writev_at() attempts to write bytes to the stream, starting at the given offset, from the buffers specified by vector and num_vector. If successful, the number of bytes actually written are return via actual.

If the write operation would write beyond the end of the stream, the function will attempt to increase the content size of the stream in order to receive the given data, filling any new, unwritten content with zero bytes.

If the resize operation fails after some amount of data was written to the stream, the function will return successfully. If no bytes were written to stream, the operation will return ZX_ERR_FILE_BIG or ZX_ERR_NO_SPACE, as appropriate.

If a NULL actual is passed in, it will be ignored.

Does not advance the seek offset of the stream.

If the contents of vector change during this operation, if any of the buffers overlap, or if any of the buffers overlap vector, the behavior is unspecified.

options is reserved for future use and must be 0.

RIGHTS

handle must be of type ZX_OBJ_TYPE_STREAM and have ZX_RIGHT_WRITE.

RETURN VALUE

zx_stream_writev_at() returns ZX_OK on success, and writes into actual (if non-NULL) the exact number of bytes written.

ERRORS

ZX_ERR_BAD_HANDLE handle is not a valid handle.

ZX_ERR_WRONG_TYPE handle is not a stream handle.

ZX_ERR_ACCESS_DENIED handle does not have the ZX_RIGHT_WRITE right.

ZX_ERR_INVALID_ARGS vector is an invalid zx_iovec_t or options has an unsupported bit set to 1.

ZX_ERR_NOT_FOUND the vector address, or an address specified within vector does not map to address in address space.

ZX_ERR_BAD_STATE the underlying data source cannot be written.

ZX_ERR_FILE_BIG the stream has exceeded a predefined maximum size limit.

ZX_ERR_NO_SPACE the underlying storage medium does not have sufficient space.

SEE ALSO