archive/archived
Archived
1
0
Fork 0
Code Activity

updated strbuf docs

Browse source
This commit is contained in:
H Hautakoski 2010-08-25 09:07:51 +02:00 • committed by Henrik Hautakoski
parent d5d79c77db
commit bc7492cb1d
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/strbuf.txt
View file

@ -19,14 +19,14 @@ A NULL terminating character is located at ->len+1 at all times so it is safe to
on any function that relies on the input being a valid C string. The API will never rely on this
and it's possible to have embedded null's because of that.
->alloc_len and ->len should not be messed with, only strbuf_* functions will know how to handle those properly.
->alloc_size and ->len should not be messed with, only strbuf_* functions will know how to handle those properly.
-- Functions
strbuf_append():
Like strncat() this function will append the buffer with the contents of 'str'
and will always copy exactly 'len' bytes.
and will always copy exactly 'len' bytes. (if memory can be obtained ofcourse)
strbuf_reduce():
@ -50,5 +50,5 @@ A malloc():ed C string of size strlen()+1 is returned that you are now responsib
strbuf_free():
Free's all the memory associted with the strbuf_t structure.
Free's all the memory (allocated on the heap) associted with the strbuf_t structure.