summaryrefslogtreecommitdiff
path: root/doc/texi/stringprep_check_version.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/texi/stringprep_check_version.texi')
-rw-r--r--doc/texi/stringprep_check_version.texi16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/texi/stringprep_check_version.texi b/doc/texi/stringprep_check_version.texi
new file mode 100644
index 0000000..2ba59d2
--- /dev/null
+++ b/doc/texi/stringprep_check_version.texi
@@ -0,0 +1,16 @@
+@subheading stringprep_check_version
+@anchor{stringprep_check_version}
+@deftypefun {const char *} {stringprep_check_version} (const char * @var{req_version})
+@var{req_version}: Required version number, or NULL.
+
+Check that the version of the library is at minimum the requested one
+and return the version string; return NULL if the condition is not
+satisfied. If a NULL is passed to this function, no check is done,
+but the version string is simply returned.
+
+See @code{STRINGPREP_VERSION} for a suitable @code{req_version} string.
+
+@strong{Return value:} Version string of run-time library, or NULL if the
+run-time library does not meet the required version number.
+@end deftypefun
+