src/cx/buffer.h

changeset 761
61d5197d612b
parent 759
475335643af4
equal deleted inserted replaced
760:52e49533e7b4 761:61d5197d612b
309 309
310 /** 310 /**
311 * Clears the buffer by resetting the position and deleting the data. 311 * Clears the buffer by resetting the position and deleting the data.
312 * 312 *
313 * The data is deleted by zeroing it with a call to memset(). 313 * The data is deleted by zeroing it with a call to memset().
314 * If you do not need that, you can use the faster cxBufferReset().
314 * 315 *
315 * @param buffer the buffer to be cleared 316 * @param buffer the buffer to be cleared
317 * @see cxBufferReset()
316 */ 318 */
317 __attribute__((__nonnull__)) 319 __attribute__((__nonnull__))
318 void cxBufferClear(CxBuffer *buffer); 320 void cxBufferClear(CxBuffer *buffer);
321
322 /**
323 * Resets the buffer by resetting the position and size to zero.
324 *
325 * The data in the buffer is not deleted. If you need a safe
326 * reset of the buffer, use cxBufferClear().
327 *
328 * @param buffer the buffer to be cleared
329 * @see cxBufferClear()
330 */
331 __attribute__((__nonnull__))
332 void cxBufferReset(CxBuffer *buffer);
319 333
320 /** 334 /**
321 * Tests, if the buffer position has exceeded the buffer size. 335 * Tests, if the buffer position has exceeded the buffer size.
322 * 336 *
323 * @param buffer the buffer to test 337 * @param buffer the buffer to test

mercurial