summaryrefslogtreecommitdiff
path: root/pod/perlapi.pod
diff options
context:
space:
mode:
authorNicholas Clark <nick@ccl4.org>2006-04-30 10:58:11 +0000
committerNicholas Clark <nick@ccl4.org>2006-04-30 10:58:11 +0000
commitd34786ba12ee5b96d9e34dd6fcdda158d7d2597b (patch)
tree24a71c61d759d5b597cab9da8ba55cfcab45b669 /pod/perlapi.pod
parent6a841143011641ad36ad4f8e2f2896eb0e1a59dc (diff)
downloadperl-d34786ba12ee5b96d9e34dd6fcdda158d7d2597b.tar.gz
Document SvGAMAGIC(), and its significance w.r.t. the side effects of
inadvertently calling magic and overloading too often. p4raw-id: //depot/perl@28021
Diffstat (limited to 'pod/perlapi.pod')
-rw-r--r--pod/perlapi.pod14
1 files changed, 14 insertions, 0 deletions
diff --git a/pod/perlapi.pod b/pod/perlapi.pod
index ec4dc71af0..88f64435e2 100644
--- a/pod/perlapi.pod
+++ b/pod/perlapi.pod
@@ -3525,6 +3525,20 @@ See C<SvCUR>. Access the character as *(SvEND(sv)).
=for hackers
Found in file sv.h
+=item SvGAMAGIC
+X<SvGAMAGIC>
+
+Returns true if the SV has get magic or overloading. If either is true then
+the scalar is active data, and has the potential to return a new value every
+time it is accessed. Hence you must be careful to only read it once per user
+logical operation and work with that returned value. If neither is true then
+the scalar's value cannot change unless written to.
+
+ char* SvGAMAGIC(SV* sv)
+
+=for hackers
+Found in file sv.h
+
=item SvGROW
X<SvGROW>