summaryrefslogtreecommitdiff
path: root/pod/perlapi.pod
diff options
context:
space:
mode:
authorJarkko Hietaniemi <jhi@iki.fi>2001-06-23 21:12:49 +0000
committerJarkko Hietaniemi <jhi@iki.fi>2001-06-23 21:12:49 +0000
commitd42b51ea3a21146024d8a93d684615acda41dd62 (patch)
tree5b1d621a60bb57afbda4aa720323b056e10dc383 /pod/perlapi.pod
parent60939fb8198cff462fb462c652e098e6d85afb44 (diff)
downloadperl-d42b51ea3a21146024d8a93d684615acda41dd62.tar.gz
Regen perlapi.
p4raw-id: //depot/perl@10871
Diffstat (limited to 'pod/perlapi.pod')
-rw-r--r--pod/perlapi.pod16
1 files changed, 14 insertions, 2 deletions
diff --git a/pod/perlapi.pod b/pod/perlapi.pod
index dac23a68f3..0f46c22790 100644
--- a/pod/perlapi.pod
+++ b/pod/perlapi.pod
@@ -555,8 +555,20 @@ Found in file op.h
Recognise (or not) a number. The type of the number is returned
(0 if unrecognised), otherwise it is a bit-ORed combination of
IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
-IS_NUMBER_NEG, IS_NUMBER_INFINITY (defined in perl.h). If the value
-of the number can fit an in UV, it is returned in the *valuep.
+IS_NUMBER_NEG, IS_NUMBER_INFINITY (defined in perl.h).
+
+If the value of the number can fit an in UV, it is returned in the *valuep
+IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
+will never be set unless *valuep is valid, but *valuep may have been assigned
+to during processing even though IS_NUMBER_IN_UV is not set on return.
+If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
+valuep is non-NULL, but no actual assignment (or SEGV) will occur.
+
+IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
+seen (in which case *valuep gives the true value truncated to an integer), and
+IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
+absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
+number is larger than a UV.
int grok_number(const char *pv, STRLEN len, UV *valuep)