summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Williamson <public@khwilliamson.com>2012-03-19 13:21:26 -0600
committerKarl Williamson <public@khwilliamson.com>2012-03-19 18:23:43 -0600
commit3c813ed0ab90d1f1f16ca848d265616ae5315536 (patch)
tree2d704a3cdfef1f3f39abc11df1966cf1a89d05c7
parentef9741a5409c0b7bf9f7ff7d92654a26eb435a49 (diff)
downloadperl-3c813ed0ab90d1f1f16ca848d265616ae5315536.tar.gz
perlapi (from sv.h) clarifications
-rw-r--r--sv.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/sv.h b/sv.h
index 60ff740501..7f79c01647 100644
--- a/sv.h
+++ b/sv.h
@@ -806,7 +806,8 @@ Set the actual length of the string which is in the SV. See C<SvIV_set>.
/*
=for apidoc Am|U32|SvUTF8|SV* sv
-Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
+Returns a U32 value indicating the UTF-8 status of an SV. If things are set-up
+properly, this indicates whether or not the SV contains UTF-8 encoded data.
Call this after SvPV() in case any call to string overloading updates the
internal flag.
@@ -815,7 +816,8 @@ Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
Do not use frivolously.
=for apidoc Am|void|SvUTF8_off|SV *sv
-Unsets the UTF-8 status of an SV.
+Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
+Do not use frivolously.
=for apidoc Am|void|SvPOK_only_UTF8|SV* sv
Tells an SV that it is a string and disables all other OK bits,