summaryrefslogtreecommitdiff
path: root/doc/pcre2_convert_context_create.3
diff options
context:
space:
mode:
authorph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069>2017-07-12 16:34:49 +0000
committerph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069>2017-07-12 16:34:49 +0000
commit44a7756fbd9de2ba246cb9a2f8c20c85efbaac2e (patch)
tree7159c7d8fd446086b5bd32fa37ca7f93071d362b /doc/pcre2_convert_context_create.3
parent4165460e9b0d5df7eba3a88b59b95a7ae95d9bb9 (diff)
downloadpcre2-44a7756fbd9de2ba246cb9a2f8c20c85efbaac2e.tar.gz
Document experimental pattern conversion functions and remove unimplemented
features. git-svn-id: svn://vcs.exim.org/pcre2/code/trunk@840 6239d852-aaf2-0410-a92c-79f79f948069
Diffstat (limited to 'doc/pcre2_convert_context_create.3')
-rw-r--r--doc/pcre2_convert_context_create.327
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/pcre2_convert_context_create.3 b/doc/pcre2_convert_context_create.3
new file mode 100644
index 0000000..91c17fb
--- /dev/null
+++ b/doc/pcre2_convert_context_create.3
@@ -0,0 +1,27 @@
+.TH PCRE2_CONVERT_CONTEXT_CREATE 3 "10 July 2017" "PCRE2 10.30"
+.SH NAME
+PCRE2 - Perl-compatible regular expressions (revised API)
+.SH SYNOPSIS
+.rs
+.sp
+.B #include <pcre2.h>
+.PP
+.nf
+.B pcre2_convert_context *pcre2_convert_context_create(
+.B " pcre2_general_context *\fIgcontext\fP);"
+.fi
+.
+.SH DESCRIPTION
+.rs
+.sp
+This function is part of an experimental set of pattern conversion functions.
+It creates and initializes a new convert context. If its argument is
+NULL, \fBmalloc()\fP is used to get the necessary memory; otherwise the memory
+allocation function within the general context is used. The result is NULL if
+the memory could not be obtained.
+.P
+The pattern conversion functions are described in the
+.\" HREF
+\fBpcre2convert\fP
+.\"
+documentation.