summaryrefslogtreecommitdiff
path: root/pod/perlapi.pod
diff options
context:
space:
mode:
authorJoe Schaefer <joe+perl@sunstarsys.com>2003-08-12 09:21:42 -0400
committerRafael Garcia-Suarez <rgarciasuarez@gmail.com>2003-08-26 20:15:40 +0000
commitd34c2299ce15c4bc317af0031fa77cc4a77ec346 (patch)
treeac6dd043ea2a23a73fb7d302d8d3f53c41874d20 /pod/perlapi.pod
parent26f600bce139656723472a5e845906a60241815e (diff)
downloadperl-d34c2299ce15c4bc317af0031fa77cc4a77ec346.tar.gz
perlapi.pod tweaks, based on :
Subject: misdocumented return value for sv_setref* Message-ID: <m3adae94gp.fsf@sol.sunstarsys.com> p4raw-id: //depot/perl@20912
Diffstat (limited to 'pod/perlapi.pod')
-rw-r--r--pod/perlapi.pod12
1 files changed, 6 insertions, 6 deletions
diff --git a/pod/perlapi.pod b/pod/perlapi.pod
index 2bbbc668b8..96766c139b 100644
--- a/pod/perlapi.pod
+++ b/pod/perlapi.pod
@@ -4367,7 +4367,7 @@ Copies an integer into a new SV, optionally blessing the SV. The C<rv>
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. The C<classname> argument indicates the package for the
blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
-will be returned and will have a reference count of 1.
+will have a reference count of 1, and the RV will be returned.
SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
@@ -4380,7 +4380,7 @@ Copies a double into a new SV, optionally blessing the SV. The C<rv>
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. The C<classname> argument indicates the package for the
blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
-will be returned and will have a reference count of 1.
+will have a reference count of 1, and the RV will be returned.
SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
@@ -4394,7 +4394,7 @@ argument will be upgraded to an RV. That RV will be modified to point to
the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
into the SV. The C<classname> argument indicates the package for the
blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
-will be returned and will have a reference count of 1.
+will have a reference count of 1, and the RV will be returned.
Do not use with other Perl types such as HV, AV, SV, CV, because those
objects will become corrupted by the pointer copy process.
@@ -4412,8 +4412,8 @@ Copies a string into a new SV, optionally blessing the SV. The length of the
string must be specified with C<n>. The C<rv> argument will be upgraded to
an RV. That RV will be modified to point to the new SV. The C<classname>
argument indicates the package for the blessing. Set C<classname> to
-C<Nullch> to avoid the blessing. The new SV will be returned and will have
-a reference count of 1.
+C<Nullch> to avoid the blessing. The new SV will have a reference count
+of 1, and the RV will be returned.
Note that C<sv_setref_pv> copies the pointer while this copies the string.
@@ -4428,7 +4428,7 @@ Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. The C<classname> argument indicates the package for the
blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
-will be returned and will have a reference count of 1.
+will have a reference count of 1, and the RV will be returned.
SV* sv_setref_uv(SV* rv, const char* classname, UV uv)