diff options
author | Gurusamy Sarathy <gsar@cpan.org> | 2001-07-02 08:03:55 +0000 |
---|---|---|
committer | Gurusamy Sarathy <gsar@cpan.org> | 2001-07-02 08:03:55 +0000 |
commit | 894237640a8731055a749592e01318892443c38d (patch) | |
tree | cc8c55e633728ba8f48fa340a50ae81dda851e26 /pod/perlapi.pod | |
parent | 25716404fbbde2ca91832aab8c9157aafcdcc7e8 (diff) | |
download | perl-894237640a8731055a749592e01318892443c38d.tar.gz |
rename s/sv_getcwd/getcwd_sv/ for better conformance to existing
naming discipline
win32 fix: enable getcwd_sv() to work on windows (POSIX.t was failing
because of this)
fix a warning about "fd" being used without being set in Cwd.xs
p4raw-id: //depot/perl@11067
Diffstat (limited to 'pod/perlapi.pod')
-rw-r--r-- | pod/perlapi.pod | 78 |
1 files changed, 39 insertions, 39 deletions
diff --git a/pod/perlapi.pod b/pod/perlapi.pod index 0f46c22790..4872a9fbc3 100644 --- a/pod/perlapi.pod +++ b/pod/perlapi.pod @@ -475,6 +475,15 @@ L<perlcall>. =for hackers Found in file scope.h +=item getcwd_sv + +Fill the sv with current working directory + + int getcwd_sv(SV* sv) + +=for hackers +Found in file util.c + =item get_av Returns the AV of the specified Perl array. If C<create> is set and the @@ -2225,22 +2234,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 efficent 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 efficent 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 @@ -2434,21 +2443,21 @@ Like C<SvPV_nolen>, but converts sv to uft8 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 @@ -2655,19 +2664,19 @@ false, defined or undefined. Does not handle 'get' magic. =for hackers Found in file sv.h -=item SvTYPE - -Returns the type of the SV. See C<svtype>. +=item svtype - svtype SvTYPE(SV* sv) +An enum of flags for Perl types. These are found in the file B<sv.h> +in the C<svtype> enum. Test these flags with the C<SvTYPE> macro. =for hackers Found in file sv.h -=item svtype +=item SvTYPE -An enum of flags for Perl types. These are found in the file B<sv.h> -in the C<svtype> enum. Test these flags with the C<SvTYPE> macro. +Returns the type of the SV. See C<svtype>. + + svtype SvTYPE(SV* sv) =for hackers Found in file sv.h @@ -2778,22 +2787,22 @@ for a version which guarantees to evaluate sv only once. =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 efficent 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 -=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 efficent C<SvUV> otherwise. - UV SvUVX(SV* sv) + UV SvUVx(SV* sv) =for hackers Found in file sv.h @@ -3205,15 +3214,6 @@ Normally called via a wrapper macro C<SvREFCNT_dec>. =for hackers Found in file sv.c -=item sv_getcwd - -Fill the sv with current working directory - - int sv_getcwd(SV* sv) - -=for hackers -Found in file util.c - =item sv_gets Get a line from the filehandle and store it into the SV, optionally |