document xsubpp SCOPE:
authorPerl 5 Porters <perl5-porters@africa.nicoh.com>
Thu, 29 Aug 1996 10:21:33 +0000 (10:21 +0000)
committerAndy Dougherty <doughera@lafcol.lafayette.edu>
Thu, 29 Aug 1996 10:21:33 +0000 (10:21 +0000)
pod/perlxs.pod

index 850960a..6a898a5 100644 (file)
@@ -416,6 +416,23 @@ A correct, but error-prone example.
           timep
           RETVAL
 
+=head2 The SCOPE: Keyword
+
+The SCOPE: keyword allows scoping to be enabled for a particular XSUB. If
+enabled, the XSUB will invoke ENTER and LEAVE automatically.
+
+To support potentially complex type mappings, if a typemap entry used
+by this XSUB contains a comment like C</*scope*/> then scoping will
+automatically be enabled for that XSUB.
+
+To enable scoping:
+
+    SCOPE: ENABLE
+
+To disable scoping:
+
+    SCOPE: DISABLE
+
 =head2 The INPUT: Keyword
 
 The XSUB's parameters are usually evaluated immediately after entering the