summaryrefslogtreecommitdiff
path: root/sv.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2014-06-06 13:11:55 -0600
committerKarl Williamson <khw@cpan.org>2014-06-07 10:24:59 -0600
commit417b32ce5913df94c743d210447cc1b0112d59f3 (patch)
tree7b16d4e9279a5d9de487d97f5bbc05fe10587942 /sv.h
parent9717af6d049902fc887c412facb2d15e785ef1a4 (diff)
downloadperl-417b32ce5913df94c743d210447cc1b0112d59f3.tar.gz
perlapi: Nit, and mention NUL for some functions
This adds the mention of embedded or terminating NULs for some functions where it wasn't previously indicated.
Diffstat (limited to 'sv.h')
-rw-r--r--sv.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/sv.h b/sv.h
index abcfbb63ae..4db63e4408 100644
--- a/sv.h
+++ b/sv.h
@@ -773,7 +773,7 @@ attributable to C<SvOOK>. See C<SvCUR>.
=for apidoc Am|char*|SvEND|SV* sv
Returns a pointer to the spot just after the last character in
the string which is in the SV, where there is usually a trailing
-C<NUL> byte (even though Perl scalars do not strictly require it).
+C<NUL> character (even though Perl scalars do not strictly require it).
See C<SvCUR>. Access the character as *(SvEND(sv)).
Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
@@ -792,7 +792,8 @@ C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
Set the value of the NV pointer in sv to val. See C<SvIV_set>.
=for apidoc Am|void|SvPV_set|SV* sv|char* val
-Set the value of the PV pointer in sv to val. See also C<SvIV_set>.
+Set the value of the PV pointer in C<sv> to the C<NUL>-terminated string
+C<val>. See also C<SvIV_set>.
Beware that the existing pointer may be involved in copy-on-write or other
mischief, so do C<SvOOK_off(sv)> and use C<sv_force_normal> or