diff options
| author | Karl Williamson <khw@cpan.org> | 2018-02-05 15:48:12 -0700 |
|---|---|---|
| committer | Karl Williamson <khw@cpan.org> | 2019-12-21 11:18:37 -0700 |
| commit | b661dc901ae20b5307829a748d58fffd161fe11e (patch) | |
| tree | ea31c5d683e068a24a406ff21067bac07c85bcba /sv.h | |
| parent | d1d17ec1ca01d3c59b76a0bf8f9882b5a4b667f6 (diff) | |
| download | perl-b661dc901ae20b5307829a748d58fffd161fe11e.tar.gz | |
Clarify SvPVbyteFOO docs
These all croak if the SV string is in UTF-8 containing wide characters.
Diffstat (limited to 'sv.h')
| -rw-r--r-- | sv.h | 13 |
1 files changed, 8 insertions, 5 deletions
@@ -1641,10 +1641,12 @@ Like C<SvPVutf8_or_null>, but does not process get magic. Like C<SvPV_nolen>, but converts C<sv> to UTF-8 first if necessary. =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len -Like C<SvPV_force>, but converts C<sv> to byte representation first if necessary. +Like C<SvPV_force>, but converts C<sv> to byte representation first if +necessary. If the SV cannot be downgraded from UTF-8, this croaks. =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len -Like C<SvPV>, but converts C<sv> to byte representation first if necessary. +Like C<SvPV>, but converts C<sv> to byte representation first if necessary. If +the SV cannot be downgraded from UTF-8, this croaks. =for apidoc Am|char*|SvPVbyte_nomg|SV* sv|STRLEN len Like C<SvPVbyte>, but does not process get magic. @@ -1656,7 +1658,8 @@ Like C<SvPVbyte>, but when C<sv> is undef, returns C<NULL>. Like C<SvPVbyte_or_null>, but does not process get magic. =for apidoc Am|char*|SvPVbyte_nolen|SV* sv -Like C<SvPV_nolen>, but converts C<sv> to byte representation first if necessary. +Like C<SvPV_nolen>, but converts C<sv> to byte representation first if +necessary. If the SV cannot be downgraded from UTF-8, this croaks. =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len Like C<SvPV_force>, but converts C<sv> to UTF-8 first if necessary. @@ -1671,12 +1674,12 @@ otherwise. =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len Like C<SvPV_force>, but converts C<sv> to byte representation first if necessary. Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte_force> -otherwise. +otherwise. If the SV cannot be downgraded from UTF-8, this croaks. =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len Like C<SvPV>, but converts C<sv> to byte representation first if necessary. Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte> -otherwise. +otherwise. If the SV cannot be downgraded from UTF-8, this croaks. =for apidoc Am|U32|SvIsCOW|SV* sv Returns a U32 value indicating whether the SV is Copy-On-Write (either shared |