summaryrefslogtreecommitdiff
path: root/sv.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2014-05-04 18:58:51 -0600
committerKarl Williamson <khw@cpan.org>2014-05-30 16:13:46 -0600
commit30a15352eb3f11a226bd42ec93797b1e778f6e9f (patch)
treeb6312c87cc3f28fe38159d37a71bafa7834234b7 /sv.h
parent6602b93363649555eb1086b0efd043f7ffa7d0b5 (diff)
downloadperl-30a15352eb3f11a226bd42ec93797b1e778f6e9f.tar.gz
perlapi: Clarify some instances where NUL is or isn't permitted
Some functions that take a string/length pair can have embedded NULs and don't have to be NUL terminated; others are the opposite. This adds text to clarify the issue.
Diffstat (limited to 'sv.h')
-rw-r--r--sv.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/sv.h b/sv.h
index 003112c48d..abcfbb63ae 100644
--- a/sv.h
+++ b/sv.h
@@ -2163,7 +2163,8 @@ struct clone_params {
/*
=for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
-Creates a new SV and copies a string into it. If utf8 is true, calls
+Creates a new SV and copies a string (which may contain C<NUL> (C<\0>)
+characters) into it. If utf8 is true, calls
C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
=cut