comparison: src/cx/buffer.h
src/cx/buffer.h
- changeset 1284
- b2103354baed
- parent 1181
- 183bf43aa9b9
equal
deleted
inserted
replaced
| 1283:89935fea4b7c | 1284:b2103354baed |
|---|---|
| 672 ); | 672 ); |
| 673 | 673 |
| 674 /** | 674 /** |
| 675 * Writes a terminating zero to a buffer at the current position. | 675 * Writes a terminating zero to a buffer at the current position. |
| 676 * | 676 * |
| 677 * On successful write, @em neither the position @em nor the size of the buffer is | 677 * If successful, sets the size to the current position and advances the position by one. |
| 678 * increased. | |
| 679 * | 678 * |
| 680 * The purpose of this function is to have the written data ready to be used as | 679 * The purpose of this function is to have the written data ready to be used as |
| 681 * a C string. | 680 * a C string with the buffer's size being the length of that string. |
| 682 * | 681 * |
| 683 * @param buffer the buffer to write to | 682 * @param buffer the buffer to write to |
| 684 * @return zero, if the terminator could be written, non-zero otherwise | 683 * @return zero, if the terminator could be written, non-zero otherwise |
| 685 */ | 684 */ |
| 686 cx_attr_nonnull | 685 cx_attr_nonnull |
