diff options
Diffstat (limited to 'doc/mans/tinyrad_array.3.in')
| -rw-r--r-- | doc/mans/tinyrad_array.3.in | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/mans/tinyrad_array.3.in b/doc/mans/tinyrad_array.3.in index 09f2019..ee82eaa 100644 --- a/doc/mans/tinyrad_array.3.in +++ b/doc/mans/tinyrad_array.3.in | |||
| @@ -62,8 +62,15 @@ TinyRad (libtinyrad, -ltinyrad) | |||
| 62 | To be written. | 62 | To be written. |
| 63 | 63 | ||
| 64 | .SH RETURN VALUES | 64 | .SH RETURN VALUES |
| 65 | On success, the functions return TINYRAD_SUCCESS, otherwise a specific error | 65 | \fBtinyrad_array_get\fR() returns \fINULL\fR if an error occurs, otherwise a |
| 66 | is returned. | 66 | pointer to the object is returned. \fBtinyrad_array_search\fR() returns -1 if |
| 67 | an error occurs, otherwise the index position of the requested object is | ||
| 68 | returned. | ||
| 69 | .sp | ||
| 70 | Upon success, \fBtinyrad_array_insert\fR() and \fBtinyrad_array_remove\fR | ||
| 71 | return the index position of the object added to or removed from the | ||
| 72 | array, otherwise -2 is returned if a memory error occured and -1 for all | ||
| 73 | other errors. | ||
| 67 | .SH SEE ALSO | 74 | .SH SEE ALSO |
| 68 | .BR tinyrad (3), | 75 | .BR tinyrad (3), |
| 69 | .BR tinyrad_stack (3), | 76 | .BR tinyrad_stack (3), |
