Install Perl 5.8.8
[msysgit.git] / mingw / html / lib / Search / Dict.html
blob5bd4628bdd0b52a4911c59b603e7caec1aeb25c9
1 <?xml version="1.0" ?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <title>look - search for key in dictionary file</title>
6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
7 <link rev="made" href="mailto:" />
8 </head>
10 <body style="background-color: white">
11 <table border="0" width="100%" cellspacing="0" cellpadding="3">
12 <tr><td class="block" style="background-color: #cccccc" valign="middle">
13 <big><strong><span class="block">&nbsp;look - search for key in dictionary file</span></strong></big>
14 </td></tr>
15 </table>
17 <p><a name="__index__"></a></p>
18 <!-- INDEX BEGIN -->
20 <ul>
22 <li><a href="#name">NAME</a></li>
23 <li><a href="#synopsis">SYNOPSIS</a></li>
24 <li><a href="#description">DESCRIPTION</a></li>
25 </ul>
26 <!-- INDEX END -->
28 <hr />
29 <p>
30 </p>
31 <h1><a name="name">NAME</a></h1>
32 <p>Search::Dict, look - search for key in dictionary file</p>
33 <p>
34 </p>
35 <hr />
36 <h1><a name="synopsis">SYNOPSIS</a></h1>
37 <pre>
38 use Search::Dict;
39 look *FILEHANDLE, $key, $dict, $fold;</pre>
40 <pre>
41 use Search::Dict;
42 look *FILEHANDLE, $params;</pre>
43 <p>
44 </p>
45 <hr />
46 <h1><a name="description">DESCRIPTION</a></h1>
47 <p>Sets file position in FILEHANDLE to be first line greater than or equal
48 (stringwise) to <em>$key</em>. Returns the new file position, or -1 if an error
49 occurs.</p>
50 <p>The flags specify dictionary order and case folding:</p>
51 <p>If <em>$dict</em> is true, search by dictionary order (ignore anything but word
52 characters and whitespace). The default is honour all characters.</p>
53 <p>If <em>$fold</em> is true, ignore case. The default is to honour case.</p>
54 <p>If there are only three arguments and the third argument is a hash
55 reference, the keys of that hash can have values <code>dict</code>, <code>fold</code>, and
56 <code>comp</code> or <code>xfrm</code> (see below), and their correponding values will be
57 used as the parameters.</p>
58 <p>If a comparison subroutine (comp) is defined, it must return less than zero,
59 zero, or greater than zero, if the first comparand is less than,
60 equal, or greater than the second comparand.</p>
61 <p>If a transformation subroutine (xfrm) is defined, its value is used to
62 transform the lines read from the filehandle before their comparison.</p>
63 <table border="0" width="100%" cellspacing="0" cellpadding="3">
64 <tr><td class="block" style="background-color: #cccccc" valign="middle">
65 <big><strong><span class="block">&nbsp;look - search for key in dictionary file</span></strong></big>
66 </td></tr>
67 </table>
69 </body>
71 </html>