docs/Writerside/topics/buffer.h.md@29e1c48d1a6c
docs/Writerside/topics/buffer.h.md
Sat, 01 Mar 2025 15:49:08 +0100
- author
- Mike Becker <universe@uap-core.de>
- date
- Sat, 01 Mar 2025 15:49:08 +0100
- changeset 1233
- 29e1c48d1a6c
- parent 1190
- a7b913d5d589
- permissions
- -rw-r--r--
add one more sentence to the example for properties source and sink
# Buffer <warning> Outdated Section - will be updated soon! </warning> Instances of this buffer implementation can be used to read from or write to memory like you would do with a stream. This allows the use of `cx_stream_copy()` (see [](streams.h.md)) to copy contents from one buffer to another, or from a file or network streams to the buffer and vice versa. More features for convenient use of the buffer can be enabled, like automatic memory management and automatic resizing of the buffer space. Since UCX 3.0, the buffer also supports automatic flushing of contents to another stream (or buffer) as an alternative to automatically resizing the buffer space. Please refer to the API doc for the fields prefixed with `flush_` to learn more. <!-- ## Undocumented Symbols (TODO) ### cxBufferAppend ### cxBufferClear ### cxBufferCreate ### cxBufferDestroy ### cxBufferEnableFlushing ### cxBufferEof ### cxBufferFlush ### cxBufferFree ### cxBufferGet ### cxBufferInit ### cxBufferMinimumCapacity ### cxBufferPut ### cxBufferPutString ### cxBufferRead ### cxBufferReset ### cxBufferSeek ### cxBufferShift ### cxBufferShiftLeft ### cxBufferShiftRight ### cxBufferTerminate ### cxBufferWrite --> <seealso> <category ref="apidoc"> <a href="https://ucx.sourceforge.io/api/buffer_8h.html">buffer.h</a> </category> </seealso>
