Back to Aurora Vision Library Lite website

You are here: Start » All Functions » Binary Data » WriteBufferArrayToBuffer

WriteBufferArrayToBuffer


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: STD.h
Namespace: avl

Writes connected content of all source buffer array items into other byte buffer.

Syntax

void avl::WriteBufferArrayToBuffer
(
	const avl::ByteBuffer& inBuffer,
	atl::Optional<int> inOffset,
	const atl::Array<avl::ByteBuffer>& inSourceBuffers,
	avl::ByteBuffer& outBuffer
)

Parameters

Name Type Range Default Description
Input value inBuffer const ByteBuffer& Initial buffer to be expanded
Input value inOffset Optional<int> 0 - 0 Write destination position
Input value inSourceBuffers const Array<ByteBuffer>& Buffers with source data to be copied
Output value outBuffer ByteBuffer& Resulting data

In-place Processing

This function supports in-place data processing - you can pass the same reference to inBuffer and outBuffer

Read more about In-place Computation.

Description

This filter is intended for assembling an array of byte buffers into a single continuous stream of data. Resulting data is stored into the output buffer.

Source data is produced by connecting data of every buffer item from the source array on the inSourceBuffers input, preserving their order. Length of data in array buffers is not restricted by any means (buffers in array can have different lengths).

Resulting ByteBuffer data on the outBuffer output is created by expanding data from buffer on the inBuffer input. Data is written starting at the position specified by the inOffset input (in bytes). When written data spans beyond the end of the input buffer the resulting buffer length is expanded (event when inOffset points beyond the end of the input buffer). When the inOffset input is set to Auto data is written at the end of the input buffer.

This filter can be used when writing an array of information to the byte buffer. Usually this filter will finalize an array execution of other buffer writing filters.

Errors

List of possible exceptions:

Error type Description
IoError Resulting buffer size is too large.
RuntimeError Invalid buffers aliasing.

See Also