mirror/libowfat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

better return value documentation

Browse Source
This commit is contained in:
leitner 2002-10-17 18:43:19 +00:00
parent 008a17b7c9
commit 2354c458a8
4 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
stralloc/stralloc_copyb.3
View File

@ -11,3 +11,6 @@ stralloc_copyb makes sure that \fIsa\fR has enough space allocated to hold
\fIbuf\fR into the stralloc. \fIbuf\fR into the stralloc.
The data that \fIsa\fR previously contained is overwritten and truncated. The data that \fIsa\fR previously contained is overwritten and truncated.
.SH "RETURN VALUE"
If stralloc_copys runs out of memory, stralloc_copys leaves \fIsa\fR
alone and return 0, otherwise it returns 1.

3
stralloc/stralloc_copys.3
View File

@ -11,5 +11,8 @@ stralloc_copys copies a \\0-terminated string from \fIbuf\fR into
\fBstralloc_copyb\fR(&\fIsa\fR, \fIbuf\fR, str_len(\fIbuf\fR)). \fBstralloc_copyb\fR(&\fIsa\fR, \fIbuf\fR, str_len(\fIbuf\fR)).
The data that \fIsa\fR previously contained is overwritten and truncated. The data that \fIsa\fR previously contained is overwritten and truncated.
.SH "RETURN VALUE"
If stralloc_copys runs out of memory, stralloc_copys leaves \fIsa\fR
alone and return 0, otherwise it returns 1.
.SH "SEE ALSO" .SH "SEE ALSO"
stralloc_copyb(3) stralloc_copyb(3)

3
stralloc/stralloc_ready.3
View File

@ -12,5 +12,8 @@ stralloc_ready makes sure that \fIsa\fR has enough space allocated to hold
not enough to hold \fIlen\fR bytes, stralloc_ready allocates at least \fIlen\fR not enough to hold \fIlen\fR bytes, stralloc_ready allocates at least \fIlen\fR
bytes of space, copies the old string into the new space, frees the bytes of space, copies the old string into the new space, frees the
old space, and returns 1. Note that this changes \fIsa\fR.s. old space, and returns 1. Note that this changes \fIsa\fR.s.
If stralloc_ready runs out of memory, it leaves \fIsa\fR alone and
returns 0.
.SH "SEE ALSO" .SH "SEE ALSO"
stralloc_readyplus(3) stralloc_readyplus(3)

3
stralloc/stralloc_readyplus.3
View File

@ -14,5 +14,8 @@ additional bytes, stralloc_ready allocates at least
\fIsa\fR->len+\fIlen\fR bytes of space, copies the old string into the \fIsa\fR->len+\fIlen\fR bytes of space, copies the old string into the
new space, frees the old space, and returns 1. Note that this changes new space, frees the old space, and returns 1. Note that this changes
\fIsa\fR.s. \fIsa\fR.s.
If stralloc_readyplus runs out of memory, it leaves \fIsa\fR alone and
returns 0.
.SH "SEE ALSO" .SH "SEE ALSO"
stralloc_ready(3) stralloc_ready(3)