summaryrefslogtreecommitdiff
path: root/pod
diff options
context:
space:
mode:
authorNicholas Clark <nick@ccl4.org>2006-04-29 17:31:27 +0000
committerNicholas Clark <nick@ccl4.org>2006-04-29 17:31:27 +0000
commit95be277cce2cef5ea17debb2d60e8f38283b5ecc (patch)
tree2fe59416dad5b6de3a910255b856938679e5337c /pod
parent6e08b83d756ad133b8bc2487444be12cd5bed405 (diff)
downloadperl-95be277cce2cef5ea17debb2d60e8f38283b5ecc.tar.gz
Add a cross reference to bytes_from_utf8() in the documentation for
utf8_to_bytes(). Regenerate perlapi.pod. p4raw-id: //depot/perl@28015
Diffstat (limited to 'pod')
-rw-r--r--pod/perlapi.pod24
1 files changed, 13 insertions, 11 deletions
diff --git a/pod/perlapi.pod b/pod/perlapi.pod
index 225a5cbc09..ec4dc71af0 100644
--- a/pod/perlapi.pod
+++ b/pod/perlapi.pod
@@ -1006,6 +1006,17 @@ cope with complex macro expressions. Always use the macro instead.
=for hackers
Found in file mathoms.c
+=item unpack_str
+X<unpack_str>
+
+The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
+and ocnt are not used. This call should not be used, use unpackstring instead.
+
+ I32 unpack_str(const char *pat, const char *patend, const char *s, const char *strbeg, const char *strend, char **new_s, I32 ocnt, U32 flags)
+
+=for hackers
+Found in file mathoms.c
+
=back
@@ -1047,17 +1058,6 @@ Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
=for hackers
Found in file pp_pack.c
-=item unpack_str
-X<unpack_str>
-
-The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
-and ocnt are not used. This call should not be used, use unpackstring instead.
-
- I32 unpack_str(const char *pat, const char *patend, const char *s, const char *strbeg, const char *strend, char **new_s, I32 ocnt, U32 flags)
-
-=for hackers
-Found in file pp_pack.c
-
=back
@@ -6314,6 +6314,8 @@ Unlike C<bytes_to_utf8>, this over-writes the original string, and
updates len to contain the new length.
Returns zero on failure, setting C<len> to -1.
+If you need a copy of the string, see C<bytes_from_utf8>.
+
NOTE: this function is experimental and may change or be
removed without notice.