diff options
Diffstat (limited to 'doc/pcre_get_substring_list.3')
| -rw-r--r-- | doc/pcre_get_substring_list.3 | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/pcre_get_substring_list.3 b/doc/pcre_get_substring_list.3 index 51d8ba5..b12b717 100644 --- a/doc/pcre_get_substring_list.3 +++ b/doc/pcre_get_substring_list.3 @@ -24,10 +24,12 @@ substrings. The arguments are: \fIlistptr\fP Where to put a pointer to the list .sp The memory in which the substrings and the list are placed is obtained by -calling \fBpcre_malloc()\fP. A pointer to a list of pointers is put in -the variable whose address is in \fIlistptr\fP. The list is terminated by a -NULL pointer. The yield of the function is zero on success or -PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained. +calling \fBpcre_malloc()\fP. The convenience function +\fBpcre_free_substring_list()\fP can be used to free it when it is no longer +needed. A pointer to a list of pointers is put in the variable whose address is +in \fIlistptr\fP. The list is terminated by a NULL pointer. The yield of the +function is zero on success or PCRE_ERROR_NOMEMORY if sufficient memory could +not be obtained. .P There is a complete description of the PCRE native API in the .\" HREF |