diff options
author | Sam Tregar <sam@tregar.com> | 2002-02-18 18:09:22 -0500 |
---|---|---|
committer | Jarkko Hietaniemi <jhi@iki.fi> | 2002-02-19 13:32:32 +0000 |
commit | 5f08bad4ff5fa1f5c9fc35ec44b00200041a325e (patch) | |
tree | f889d99cbacd1e6e8a8135677ef09cef1d2908e2 /sv.h | |
parent | 87e4f210180fef5c43656dd9dd5f72e3a3e26b58 (diff) | |
download | perl-5f08bad4ff5fa1f5c9fc35ec44b00200041a325e.tar.gz |
Clarify SvPV and SvPV_force api docs
Message-ID: <Pine.LNX.4.44.0202182305350.10037-100000@localhost.localdomain>
p4raw-id: //depot/perl@14768
Diffstat (limited to 'sv.h')
-rw-r--r-- | sv.h | 20 |
1 files changed, 12 insertions, 8 deletions
@@ -834,24 +834,28 @@ Taints an SV if tainting is enabled /* =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len -Like <SvPV> but will force the SV into becoming a string (SvPOK). You want -force if you are going to update the SvPVX directly. +Like C<SvPV> but will force the SV into containing just a string +(C<SvPOK_only>). You want force if you are going to update the C<SvPVX> +directly. =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len -Like <SvPV> but will force the SV into becoming a string (SvPOK). You want -force if you are going to update the SvPVX directly. Doesn't process magic. +Like C<SvPV> but will force the SV into containing just a string +(C<SvPOK_only>). You want force if you are going to update the C<SvPVX> +directly. Doesn't process magic. =for apidoc Am|char*|SvPV|SV* sv|STRLEN len -Returns a pointer to the string in the SV, or a stringified form of the SV -if the SV does not contain a string. Handles 'get' magic. See also +Returns a pointer to the string in the SV, or a stringified form of +the SV if the SV does not contain a string. The SV may cache the +stringified version becoming C<SvPOK>. Handles 'get' magic. See also C<SvPVx> for a version which guarantees to evaluate sv only once. =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len A version of C<SvPV> which guarantees to evaluate sv only once. =for apidoc Am|char*|SvPV_nolen|SV* sv -Returns a pointer to the string in the SV, or a stringified form of the SV -if the SV does not contain a string. Handles 'get' magic. +Returns a pointer to the string in the SV, or a stringified form of +the SV if the SV does not contain a string. The SV may cache the +stringified form becoming C<SvPOK>. Handles 'get' magic. =for apidoc Am|IV|SvIV|SV* sv Coerces the given SV to an integer and returns it. See C<SvIVx> for a |