From: Jarkko Hietaniemi Date: Tue, 5 Sep 2000 21:16:01 +0000 (+0000) Subject: Document the SvIOK_.*UV(). X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=e331fc526c631ec7738ea465ef21f191ba7f166b;p=p5sagit%2Fp5-mst-13.2.git Document the SvIOK_.*UV(). p4raw-id: //depot/perl@7017 --- diff --git a/pod/perlapi.pod b/pod/perlapi.pod index ccb159d..76afa0e 100644 --- a/pod/perlapi.pod +++ b/pod/perlapi.pod @@ -1906,6 +1906,15 @@ the B setting. Use C. =for hackers Found in file sv.h +=item SvIOK_notUV + +Returns a boolean indicating whether the SV contains an signed integer. + + void SvIOK_notUV(SV* sv) + +=for hackers +Found in file sv.h + =item SvIOK_off Unsets the IV status of an SV. @@ -1933,6 +1942,24 @@ Tells an SV that it is an integer and disables all other OK bits. =for hackers Found in file sv.h +=item SvIOK_only_UV + +Tells and SV that it is an unsigned integer and disables all other OK bits. + + void SvIOK_only_UV(SV* sv) + +=for hackers +Found in file sv.h + +=item SvIOK_UV + +Returns a boolean indicating whether the SV contains an unsigned integer. + + void SvIOK_UV(SV* sv) + +=for hackers +Found in file sv.h + =item SvIV Coerces the given SV to an integer and returns it. @@ -2318,19 +2345,19 @@ false, defined or undefined. Does not handle 'get' magic. =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 -in the C enum. Test these flags with the C macro. +Returns the type of the SV. See C. + + svtype SvTYPE(SV* sv) =for hackers Found in file sv.h -=item SvTYPE - -Returns the type of the SV. See C. +=item svtype - svtype SvTYPE(SV* sv) +An enum of flags for Perl types. These are found in the file B +in the C enum. Test these flags with the C macro. =for hackers Found in file sv.h diff --git a/sv.h b/sv.h index 5500d2b..b91cc5f 100644 --- a/sv.h +++ b/sv.h @@ -442,6 +442,15 @@ Unsets the IV status of an SV. =for apidoc Am|void|SvIOK_only|SV* sv Tells an SV that it is an integer and disables all other OK bits. +=for apidoc Am|void|SvIOK_only_UV|SV* sv +Tells and SV that it is an unsigned integer and disables all other OK bits. + +=for apidoc Am|void|SvIOK_UV|SV* sv +Returns a boolean indicating whether the SV contains an unsigned integer. + +=for apidoc Am|void|SvIOK_notUV|SV* sv +Returns a boolean indicating whether the SV contains an signed integer. + =for apidoc Am|bool|SvNOK|SV* sv Returns a boolean indicating whether the SV contains a double.