ossp-pkg/var/var.pod 1.13 -> 1.14
--- var.pod 2001/12/12 16:51:20 1.13
+++ var.pod 2001/12/12 17:18:55 1.14
@@ -166,19 +166,21 @@
A pointer to a character pointer in which the location of the expanded
text buffer will be stored. The result buffer will be allocated by
var_expand() using the system call malloc(3), thus it is the caller's
-responsibility to free(3) that buffer once it is not used anymore.
+responsibility to free(3) that buffer once it is not used anymore. The
+result buffer will be terminated by null byte, which is not included
+in the "result_len" counter.
If var_expand() fails with an error, "result" will point to "input".
-The only exception is the VAR_ERR_INVALID_ARGUMENT error, in which
-case "result" is not modified.
+The only exceptions are the VAR_ERR_INVALID_ARGUMENT
+VAR_ERR_OUT_OF_MEMORY errors, in which case "result" is undefined.
=item size_t *result_len
A pointer to the location in which the length of the expanded text
buffer will be stored. If var_expand() fails with an error -- with the
-exception of VAR_ERR_INVALID_ARGUMENT --, "result_len" will contain
-the number of characters that have been consumed from "input" before
-the error occured.
+exception of VAR_ERR_INVALID_ARGUMENT and VAR_ERR_OUT_OF_MEMORY --,
+"result_len" will contain the number of characters that have been
+consumed from "input" before the error occured.
=item var_cb_t lookup
|
|
