From: Roderick Schertler <roderick@gate.net>
Date: Wed, 7 Feb 1996 17:11:21 +0000 (-0500)
Subject: tied() documentation
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=f3cbc33408507a5467234f328be95028ae8ee3d6;p=p5sagit%2Fp5-mst-13.2.git

tied() documentation

Here's some documentation for tied(), there doesn't seem to be any in
2b3.  Also included is a small comment in the FIRSTKEY() hash example of
perltie.pod, I had to look twice when I first saw the code and I thought
others might benefit from the explanation.
---

diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod
index a857910..7017c8f 100644
--- a/pod/perlfunc.pod
+++ b/pod/perlfunc.pod
@@ -149,7 +149,7 @@ do, import, no, package, require, use
 
 =item Keywords related to classes and object-orientedness
 
-bless, dbmclose, dbmopen, package, ref, tie, untie, use
+bless, dbmclose, dbmopen, package, ref, tie, tied, untie, use
 
 =item Low-level socket functions
 
@@ -3024,6 +3024,13 @@ Unlike dbmopen(), the tie() function will not use or require a module
 for you--you need to do that explicitly yourself.  See L<DB_File>
 or the F<Config> module for interesting tie() implementations.
 
+=item tied VARIABLE
+
+Returns a reference to the object underlying VARIABLE (the same value
+that was originally returned by the tie() call which bound the variable
+to a package.)  Returns the undefined value if VARIABLE isn't tied to a
+package.
+
 =item time
 
 Returns the number of non-leap seconds since 00:00:00 UTC, January 1,