doc/ir-scan.n

   1 .\" Copyright (c) 1995, 1996 Index Data
   2 .\" All rights reserved.
   3 .\" $Id: ir-scan.n,v 1.2 2002-09-16 22:16:10 adam Exp $
   4 .TH ir-scan n  "24 June 1996" "IrTcl" "IR Scan"
   5 .SH NAME
   6 ir-scan \- IR scan
   7 .SH SYNOPSIS
   8 .BI "ir-scan " zs " " za
   9 .sp
  10 .SH DESCRIPTION
  11 The Tcl command
  12 .B ir-scan
  13 creates an IR scan object \fIzs\fR that belongs to the IR association \fIza\fR.
  14 The ir-scan describes a scan object and the scan terms returned by a target.
  15 When a scan object is created it contains no scan terms (yet).
  16 When scan terms are returned by the target they are automatically stored
  17 at their logical positions.
  18 .SH SCAN REQUEST
  19 Operations that are used to scan (browse) a target:
  20 .TP
  21 .BI "" za " databaseNames " db1 " " db2 " " ...
  22 Sets the database(s) to be used in the following scan request(s).
  23 .TP
  24 .BI "" zs " scan " query
  25 Sends a scan request. The \fIquery\fR must follow the RPN-query syntax.
  26 .TP
  27 .BI "" zs " stepSize [" size "]"
  28 Sets/gets the step-size to be used in the following scan requests. Default
  29 is 0.
  30 .TP
  31 .BI "" zs " numberOfTermsRequested [" number "]"
  32 Sets/gets the number-of-terms-requested used in the following scan requests.
  33 Defaults to 20.
  34 .TP
  35 .BI "" zs " preferredPositionInResponse [" position "]"
  36 Sets/gets the preferred-position-in-response. Defaults to 1.
  37 .SH SCAN RESPONSE
  38 Operations used to handle the scan-response:
  39 .TP
  40 .BI "" zs " scanStatus"
  41 Returns the scan status (integer).
  42 .TP
  43 .BI "" zs " numberOfEntriesReturned"
  44 Returns the number-of-entries returned by the target.
  45 .TP
  46 .BI "" zs " positionOfTerm"
  47 Returns position-of-term.
  48 .TP
  49 .BI "" zs " stepSize"
  50 Returns the step-size of the terms returned by the target.
  51 .TP
  52 .BI "" zs " scanLine " position
  53 Returns information about the scan-term at the given \fIposition\fR.
  54 If the first token returned is \fBSD\fR the rest of the scan term
  55 describes a surrogate diagnostic message and the three tokens that follow
  56 are error-code, error-message and additional-information respectively; if
  57 the first token is \fBT\fR the rest is a normal scan term and two tokens
  58 that follow are the token itself and the number of occurrences; finally, if
  59 no scan term is available at the position, the empty string is returned.
  60 .SH "SEE ALSO"
  61 .BR ir-assoc "(n)" , " " ir-set "(n)"