diff options
| -rw-r--r-- | pod/perlapi.pod | 56 | ||||
| -rw-r--r-- | util.c | 10 |
2 files changed, 33 insertions, 33 deletions
diff --git a/pod/perlapi.pod b/pod/perlapi.pod index 91880e498f..52051ffa11 100644 --- a/pod/perlapi.pod +++ b/pod/perlapi.pod @@ -3029,22 +3029,22 @@ which guarantees to evaluate sv only once. =for hackers Found in file sv.h -=item SvNVX +=item SvNVx -Returns the raw value in the SV's NV slot, without checks or conversions. -Only use when you are sure SvNOK is true. See also C<SvNV()>. +Coerces the given SV to a double and returns it. Guarantees to evaluate +sv only once. Use the more efficient C<SvNV> otherwise. - NV SvNVX(SV* sv) + NV SvNVx(SV* sv) =for hackers Found in file sv.h -=item SvNVx +=item SvNVX -Coerces the given SV to a double and returns it. Guarantees to evaluate -sv only once. Use the more efficient C<SvNV> otherwise. +Returns the raw value in the SV's NV slot, without checks or conversions. +Only use when you are sure SvNOK is true. See also C<SvNV()>. - NV SvNVx(SV* sv) + NV SvNVX(SV* sv) =for hackers Found in file sv.h @@ -3238,21 +3238,21 @@ Like C<SvPV_nolen>, but converts sv to utf8 first if necessary. =for hackers Found in file sv.h -=item SvPVx +=item SvPVX -A version of C<SvPV> which guarantees to evaluate sv only once. +Returns a pointer to the physical string in the SV. The SV must contain a +string. - char* SvPVx(SV* sv, STRLEN len) + char* SvPVX(SV* sv) =for hackers Found in file sv.h -=item SvPVX +=item SvPVx -Returns a pointer to the physical string in the SV. The SV must contain a -string. +A version of C<SvPV> which guarantees to evaluate sv only once. - char* SvPVX(SV* sv) + char* SvPVx(SV* sv, STRLEN len) =for hackers Found in file sv.h @@ -3500,22 +3500,22 @@ for a version which guarantees to evaluate sv only once. =for hackers Found in file sv.h -=item SvUVX +=item SvUVx -Returns the raw value in the SV's UV slot, without checks or conversions. -Only use when you are sure SvIOK is true. See also C<SvUV()>. +Coerces the given SV to an unsigned integer and returns it. Guarantees to +evaluate sv only once. Use the more efficient C<SvUV> otherwise. - UV SvUVX(SV* sv) + UV SvUVx(SV* sv) =for hackers Found in file sv.h -=item SvUVx +=item SvUVX -Coerces the given SV to an unsigned integer and returns it. Guarantees to -evaluate sv only once. Use the more efficient C<SvUV> otherwise. +Returns the raw value in the SV's UV slot, without checks or conversions. +Only use when you are sure SvIOK is true. See also C<SvUV()>. - UV SvUVx(SV* sv) + UV SvUVX(SV* sv) =for hackers Found in file sv.h @@ -5400,8 +5400,9 @@ Found in file XSUB.h =item croak This is the XSUB-writer's interface to Perl's C<die> function. -Normally use this function the same way you use the C C<printf> -function. See C<warn>. +Normally call this function the same way you call the C C<printf> +function. Calling C<croak> returns control directly to Perl, +sidestepping the normal C order of execution. See C<warn>. If you want to throw an exception object, assign the object to C<$@> and then pass C<Nullch> to croak(): @@ -5417,9 +5418,8 @@ Found in file util.c =item warn -This is the XSUB-writer's interface to Perl's C<warn> function. Use this -function the same way you use the C C<printf> function. See -C<croak>. +This is the XSUB-writer's interface to Perl's C<warn> function. Call this +function the same way you call the C C<printf> function. See C<croak>. void warn(const char* pat, ...) @@ -1224,8 +1224,9 @@ Perl_croak_nocontext(const char *pat, ...) =for apidoc croak This is the XSUB-writer's interface to Perl's C<die> function. -Normally use this function the same way you use the C C<printf> -function. See C<warn>. +Normally call this function the same way you call the C C<printf> +function. Calling C<croak> returns control directly to Perl, +sidestepping the normal C order of execution. See C<warn>. If you want to throw an exception object, assign the object to C<$@> and then pass C<Nullch> to croak(): @@ -1310,9 +1311,8 @@ Perl_warn_nocontext(const char *pat, ...) /* =for apidoc warn -This is the XSUB-writer's interface to Perl's C<warn> function. Use this -function the same way you use the C C<printf> function. See -C<croak>. +This is the XSUB-writer's interface to Perl's C<warn> function. Call this +function the same way you call the C C<printf> function. See C<croak>. =cut */ |