summaryrefslogtreecommitdiff
path: root/sv.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2017-01-04 22:25:15 -0700
committerKarl Williamson <khw@cpan.org>2017-01-05 12:13:36 -0700
commitd8732c60696bbb69e2a8d8d28eed06f5eb2034a6 (patch)
treed7a0c6fb4ca9ce3d82a8133f52a0d841d3bd03b5 /sv.h
parent7a7d14f32842bc6e1bfe10da953175395f67b4e2 (diff)
downloadperl-d8732c60696bbb69e2a8d8d28eed06f5eb2034a6.tar.gz
perlapi: Add clarification for SvGROW()
Diffstat (limited to 'sv.h')
-rw-r--r--sv.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/sv.h b/sv.h
index e311ff2c02..6227d46a0a 100644
--- a/sv.h
+++ b/sv.h
@@ -2013,6 +2013,9 @@ Returns a pointer to the character
buffer. SV must be of type >= C<SVt_PV>. One
alternative is to call C<sv_grow> if you are not sure of the type of SV.
+You might mistakenly think that C<len> is the number of bytes to add to the
+existing size, but instead it is the total size C<sv> should be.
+
=for apidoc Am|char *|SvPVCLEAR|SV* sv
Ensures that sv is a SVt_PV and that its SvCUR is 0, and that it is
properly null terminated. Equivalent to sv_setpvs(""), but more efficient.