home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _c17aafef1f5cfad588c2440cfc9ee083 < prev    next >
Text File  |  2000-03-23  |  5KB  |  142 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Tie::StdHandle  - base class definitions for tied handles</TITLE>
  5. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Tie::StdHandle  - base class definitions for tied handles</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#more information">MORE INFORMATION</A></LI>
  26. </UL>
  27. <!-- INDEX END -->
  28.  
  29. <HR>
  30. <P>
  31. <H1><A NAME="name">NAME</A></H1>
  32. <P>Tie::Handle, Tie::StdHandle  - base class definitions for tied handles</P>
  33. <P>
  34. <HR>
  35. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  36. <UL>
  37. <LI>Linux</LI>
  38. <LI>Solaris</LI>
  39. <LI>Windows</LI>
  40. </UL>
  41. <HR>
  42. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  43. <PRE>
  44.     package NewHandle;
  45.     require Tie::Handle;</PRE>
  46. <PRE>
  47.     @ISA = (Tie::Handle);</PRE>
  48. <PRE>
  49.     sub READ { ... }            # Provide a needed method
  50.     sub TIEHANDLE { ... }       # Overrides inherited method</PRE>
  51. <PRE>
  52.     package main;</PRE>
  53. <PRE>
  54.     tie *FH, 'NewHandle';</PRE>
  55. <P>
  56. <HR>
  57. <H1><A NAME="description">DESCRIPTION</A></H1>
  58. <P>This module provides some skeletal methods for handle-tying classes. See
  59. <A HREF="../../lib/Pod/perltie.html">the perltie manpage</A> for a list of the functions required in tying a handle to a package.
  60. The basic <STRONG>Tie::Handle</STRONG> package provides a <CODE>new</CODE> method, as well as methods
  61. <CODE>TIEHANDLE</CODE>, <CODE>PRINT</CODE>, <CODE>PRINTF</CODE> and <CODE>GETC</CODE>.</P>
  62. <P>For developers wishing to write their own tied-handle classes, the methods
  63. are summarized below. The <A HREF="../../lib/Pod/perltie.html">the perltie manpage</A> section not only documents these, but
  64. has sample code as well:</P>
  65. <DL>
  66. <DT><STRONG><A NAME="item_TIEHANDLE_classname%2C_LIST">TIEHANDLE classname, LIST</A></STRONG><BR>
  67. <DD>
  68. The method invoked by the command <CODE>tie *glob, classname</CODE>. Associates a new
  69. glob instance with the specified class. <CODE>LIST</CODE> would represent additional
  70. arguments (along the lines of <A HREF="../../lib/AnyDBM_File.html">the AnyDBM_File manpage</A> and compatriots) needed to
  71. complete the association.
  72. <P></P>
  73. <DT><STRONG><A NAME="item_WRITE_this%2C_scalar%2C_length%2C_offset">WRITE this, scalar, length, offset</A></STRONG><BR>
  74. <DD>
  75. Write <EM>length</EM> bytes of data from <EM>scalar</EM> starting at <EM>offset</EM>.
  76. <P></P>
  77. <DT><STRONG><A NAME="item_PRINT_this%2C_LIST">PRINT this, LIST</A></STRONG><BR>
  78. <DD>
  79. Print the values in <EM>LIST</EM>
  80. <P></P>
  81. <DT><STRONG><A NAME="item_PRINTF_this%2C_format%2C_LIST">PRINTF this, format, LIST</A></STRONG><BR>
  82. <DD>
  83. Print the values in <EM>LIST</EM> using <EM>format</EM>
  84. <P></P>
  85. <DT><STRONG><A NAME="item_READ_this%2C_scalar%2C_length%2C_offset">READ this, scalar, length, offset</A></STRONG><BR>
  86. <DD>
  87. Read <EM>length</EM> bytes of data into <EM>scalar</EM> starting at <EM>offset</EM>.
  88. <P></P>
  89. <DT><STRONG><A NAME="item_READLINE_this">READLINE this</A></STRONG><BR>
  90. <DD>
  91. Read a single line
  92. <P></P>
  93. <DT><STRONG><A NAME="item_GETC_this">GETC this</A></STRONG><BR>
  94. <DD>
  95. Get a single character
  96. <P></P>
  97. <DT><STRONG><A NAME="item_CLOSE_this">CLOSE this</A></STRONG><BR>
  98. <DD>
  99. Close the handle
  100. <P></P>
  101. <DT><STRONG><A NAME="item_OPEN_this%2C_filename">OPEN this, filename</A></STRONG><BR>
  102. <DD>
  103. (Re-)open the handle
  104. <P></P>
  105. <DT><STRONG><A NAME="item_BINMODE_this">BINMODE this</A></STRONG><BR>
  106. <DD>
  107. Specify content is binary
  108. <P></P>
  109. <DT><STRONG><A NAME="item_EOF_this">EOF this</A></STRONG><BR>
  110. <DD>
  111. Test for end of file.
  112. <P></P>
  113. <DT><STRONG><A NAME="item_TELL_this">TELL this</A></STRONG><BR>
  114. <DD>
  115. Return position in the file.
  116. <P></P>
  117. <DT><STRONG><A NAME="item_SEEK_this%2C_offset%2C_whence">SEEK this, offset, whence</A></STRONG><BR>
  118. <DD>
  119. Position the file.
  120. <P>Test for end of file.</P>
  121. <P></P>
  122. <DT><STRONG><A NAME="item_DESTROY_this">DESTROY this</A></STRONG><BR>
  123. <DD>
  124. Free the storage associated with the tied handle referenced by <EM>this</EM>.
  125. This is rarely needed, as Perl manages its memory quite well. But the
  126. option exists, should a class wish to perform specific actions upon the
  127. destruction of an instance.
  128. <P></P></DL>
  129. <P>
  130. <HR>
  131. <H1><A NAME="more information">MORE INFORMATION</A></H1>
  132. <P>The <A HREF="../../lib/Pod/perltie.html">the perltie manpage</A> section contains an example of tying handles.</P>
  133. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  134. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  135. <STRONG><P CLASS=block> Tie::StdHandle  - base class definitions for tied handles</P></STRONG>
  136. </TD></TR>
  137. </TABLE>
  138.  
  139. </BODY>
  140.  
  141. </HTML>
  142.