Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Search::Dict (3)

Name

Search::Dict - search for key in dictionary file

Synopsis

use Search::Dict;
look *FILEHANDLE, $key, $dict, $fold;

use Search::Dict;
look *FILEHANDLE, $params;

Description

Perl Programmers Reference Guide                               Search::Dict(3)



NAME
       Search::Dict - look - search for key in dictionary file

SYNOPSIS
           use Search::Dict;
           look *FILEHANDLE, $key, $dict, $fold;

           use Search::Dict;
           look *FILEHANDLE, $params;

DESCRIPTION
       Sets file position in FILEHANDLE to be first line greater than or equal
       (stringwise) to $key.  Returns the new file position, or -1 if an error
       occurs.

       The flags specify dictionary order and case folding:

       If $dict is true, search by dictionary order (ignore anything but word
       characters and whitespace).  The default is honour all characters.

       If $fold is true, ignore case.  The default is to honour case.

       If there are only three arguments and the third argument is a hash
       reference, the keys of that hash can have values "dict", "fold", and
       "comp" or "xfrm" (see below), and their corresponding values will be
       used as the parameters.

       If a comparison subroutine (comp) is defined, it must return less than
       zero, zero, or greater than zero, if the first comparand is less than,
       equal, or greater than the second comparand.

       If a transformation subroutine (xfrm) is defined, its value is used to
       transform the lines read from the filehandle before their comparison.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14                   Search::Dict(3)