diff options
| author | Steve Peters <steve@fisharerojo.org> | 2005-05-26 09:58:50 -0500 |
|---|---|---|
| committer | Rafael Garcia-Suarez <rgarciasuarez@gmail.com> | 2005-05-27 07:04:46 +0000 |
| commit | 20799e15002c0f6181bd67bc4dc9cb5aad636ec7 (patch) | |
| tree | 0513f8b29b7da1b864cae573bcbc7c8893ad59f5 /sv.h | |
| parent | 88daff1375d29616070e82b2efba4d2d3533e833 (diff) | |
| download | perl-20799e15002c0f6181bd67bc4dc9cb5aad636ec7.tar.gz | |
Documentation nits and fixes for Sv*_set() macros
Message-ID: <20050526195850.GA1308@mccoy.peters.homeunix.org>
p4raw-id: //depot/perl@24592
Diffstat (limited to 'sv.h')
| -rw-r--r-- | sv.h | 22 |
1 files changed, 13 insertions, 9 deletions
@@ -642,31 +642,35 @@ See C<SvCUR>. Access the character as *(SvEND(sv)). Returns the stash of the SV. =for apidoc Am|void|SvIV_set|SV* sv|IV val -Set the value of the IV pointer in sv to val. +Set the value of the IV pointer in sv to val. It is possible to perform +the same function of this macro with an lvalue assignment to C<SvIVX>. +With future Perls, however, it will be more efficient to use +C<SvIV_set> instead of the lvalue assignment to C<SvIVX>. =for apidoc Am|void|SvNV_set|SV* sv|NV val -Set the value of the IV pointer in sv to val. +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. +Set the value of the PV pointer in sv to val. See C<SvIV_set>. =for apidoc Am|void|SvUV_set|SV* sv|UV val -Set the value of the PV pointer in sv to val. +Set the value of the UV pointer in sv to val. See C<SvIV_set>. =for apidoc Am|void|SvRV_set|SV* sv|SV* val -Set the value of the RV pointer in sv to val. +Set the value of the RV pointer in sv to val. See C<SvIV_set>. =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val -Set the value of the MAGIC pointer in sv to val. +Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>. =for apidoc Am|void|SvSTASH_set|SV* sv|STASH* val -Set the value of the STASH pointer in sv to val. +Set the value of the STASH pointer in sv to val. See C<SvIV_set>. =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len -Set the current length of the string which is in the SV. See C<SvCUR>. +Set the current length of the string which is in the SV. See C<SvCUR> +and C<SvIV_set>. =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len -Set the actual length of the string which is in the SV. +Set the actual length of the string which is in the SV. See C<SvIV_set>. =cut */ |