Index: phpdoc/en/reference/yaz/configure.xml
diff -u phpdoc/en/reference/yaz/configure.xml:1.2 phpdoc/en/reference/yaz/configure.xml:1.3
--- phpdoc/en/reference/yaz/configure.xml:1.2 Fri Jan 10 20:15:30 2003
+++ phpdoc/en/reference/yaz/configure.xml Thu Jan 16 04:44:49 2003
@@ -1,10 +1,10 @@
-
+
&reftitle.install;
- Compile YAZ (ANSI/NISO Z39.50) and install it. Build PHP with your favourite
- modules and add option
+ Compile YAZ (ANSI/NISO Z39.50 support) and install it.
+ Build PHP with your favourite modules and add option
.
Your task is roughly the following:
@@ -12,13 +12,13 @@
-
+
YAZ functionsYAZ
@@ -9,15 +9,16 @@
&reftitle.intro;
This extension offers a PHP interface to the
- YAZ toolkit that implements the Z39.50
- protocol for information retrieval. With this extension you can easily
- implement a Z39.50 origin (client) that searches or scans Z39.50
- targets (servers) in parallel.
+ YAZ toolkit that implements the
+ Z39.50
+ Protocol for Information Retrieval.
+ With this extension you can easily implement a Z39.50 origin (client)
+ that searches or scans Z39.50 targets (servers) in parallel.
The module hides most of the complexity of Z39.50 so it should be
fairly easy to use. It supports persistent stateless connections very
- similar to those offered by the various SQL APIs that are available
+ similar to those offered by the various RDB APIs that are available
for PHP. This means that sessions are stateless but shared amongst
users, thus saving the connect and initialize phase steps in most
cases.
@@ -48,8 +49,8 @@
&reftitle.examples;
PHP/YAZ keeps track of connections with targets
- (Z-Associations). A positive integer represents the ID of a
- particular association.
+ (Z-Associations). A resource represents a connection to a
+ target.
@@ -57,8 +58,8 @@
The script below demonstrates the parallel searching feature of
the API. When invoked with no arguments it prints a query form; else
- (arguments are supplied) it searches the targets as given in in array
- host.
+ (arguments are supplied) it searches the targets as given in array
+ host.
local test
- BELL Labs Library
+ name="host[]" value="z3950.loc.gov:7090/voyager">
+ Library of Congress
RPN Query:
@@ -83,7 +84,7 @@
echo 'You searced for ' . htmlspecialchars($term) . ' ';
for ($i = 0; $i < $num_hosts; $i++) {
$id[] = yaz_connect($host[$i]);
- yaz_syntax($id[$i],"sutrs");
+ yaz_range($id[$i], 1, 10);
yaz_search($id[$i],"rpn",$term);
}
yaz_wait();
Index: phpdoc/en/reference/yaz/functions/yaz-addinfo.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.2 Wed Apr 17 02:45:26 2002
+++ phpdoc/en/reference/yaz/functions/yaz-addinfo.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -9,8 +9,8 @@
Description
- intyaz_addinfo
- intid
+ stringyaz_addinfo
+ resourceid
Returns additional error message for target (last request). An
Index: phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.2 Wed Apr 17 02:45:26 2002
+++ phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -10,7 +10,7 @@
Descriptionintyaz_ccl_conf
- intid
+ resourceidarrayconfig
@@ -32,15 +32,15 @@
In the example below, the CCL parser is configured to support
three CCL fields: ti, au and
isbn. Each field is mapped to their BIB-1
- equivalent. It is assumed that variable $id is a
- target ID.
+ equivalent. It is assumed that variable $id is the
+ connection ID.
Index: phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.2 Wed Apr 17 02:45:26 2002
+++ phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -10,12 +10,12 @@
Descriptionintyaz_ccl_parse
- intid
+ resourceidstringqueryarray &result
- This function invokes the CCL parser. It converts a given
+ This function invokes a CCL parser. It converts a given
CCL FIND query to an RPN query which may be passed to the
yaz_search function to perform a search.
To define a set of valid CCL fields call
@@ -32,6 +32,23 @@
errorposapproximate position in query of failure
(integer is character position).
+
+ CCL Parsing
+ We'll try to search using CCL. In the example below,
+ $ccl is a CCL query.
+
+
+
+
+
Index: phpdoc/en/reference/yaz/functions/yaz-close.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-close.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-close.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-close.xml:1.2 Wed Apr 17 02:45:27 2002
+++ phpdoc/en/reference/yaz/functions/yaz-close.xml Thu Jan 16 04:44:49 2003
@@ -1,21 +1,21 @@
-
+
yaz_close
- Closes a YAZ connection
+ Close YAZ connectionDescriptionintyaz_close
- intid
+ resourceid
- Closes the Z-association given by id.
- The id is a target ID as returned by a
- previous yaz_connect command.
+ Closes connection given by id.
+ The id is a connection resource as returned
+ by a previous yaz_connect call.
Index: phpdoc/en/reference/yaz/functions/yaz-connect.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.2 Wed Apr 17 02:45:27 2002
+++ phpdoc/en/reference/yaz/functions/yaz-connect.xml Thu Jan 16 04:44:49 2003
@@ -1,31 +1,31 @@
-
+
yaz_connect
- Prepares for a connection and Z-association to a Z39.50 target.
+ Prepares for a connection to a Z39.50 target (server).
Description
- intyaz_connect
+ resourceyaz_connectstringzurlmixedoptions
- This function returns a positive ID on success; zero on
+ This function returns a connection resource on success; zero on
failure.
yaz_connect prepares for a connection to a
- Z39.50 target. The zurl argument takes the form
+ Z39.50 target. The zurl argument takes the form
host[:port][/database]. If port is omitted 210 is used. If
- database is omitted Default is used. This function is
- non-blocking and doesn't attempt to establish a socket - it
- merely prepares a connect to be performed later when
+ database is omitted Default is used.
+ This function is non-blocking and doesn't attempt to establish
+ a socket - it merely prepares a connect to be performed later when
yaz_wait is called.
@@ -77,6 +77,12 @@
+
+ The use of a proxy often improves performance. A Z39.50 proxy
+ is part of the free YAZ++
+ package.
+
+
Index: phpdoc/en/reference/yaz/functions/yaz-database.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-database.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-database.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-database.xml:1.2 Wed Apr 17 02:45:27 2002
+++ phpdoc/en/reference/yaz/functions/yaz-database.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -12,7 +12,7 @@
Descriptionintyaz_database
- intid
+ resourceidstringdatabases
Index: phpdoc/en/reference/yaz/functions/yaz-element.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-element.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-element.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-element.xml:1.2 Wed Apr 17 02:45:27 2002
+++ phpdoc/en/reference/yaz/functions/yaz-element.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -12,15 +12,16 @@
Descriptionintyaz_element
- intid
+ resourceidstringelementset
- This function is used in conjunction with
- yaz_search and yaz_present
+ This function sets the element set name for retrieval.
+ Call this function before yaz_search or
+ yaz_present
to specify the element set name for records to be retrieved.
- Most servers support F (full) and
- B (brief).
+ Most servers support F (for full records) and
+ B (for brief records).
Returns &true; on success; &false; on error.
Index: phpdoc/en/reference/yaz/functions/yaz-errno.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.2 Wed Apr 17 02:45:27 2002
+++ phpdoc/en/reference/yaz/functions/yaz-errno.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -10,20 +10,20 @@
Descriptionintyaz_errno
- intid
+ resourceid
- Returns error for target (last request). A positive value is
- returned if the target returned a diagnostic code; a value of
- zero is returned if no errors occurred (success); negative value
- is returned for other errors (such as when the target
- closed connection, etc).
+ Returns error for target (last request). The error code is either
+ a Z39.50 diagnostic code (usually a Bib-1 diagnostic) or a
+ client side error code which is generated by PHP/YAZ itself, such
+ as "Connect failed", "Init Rejected", etc.
yaz_errno should be called after network
activity for each target - (after yaz_wait
returns) to determine the success or failure of the last
- operation (e.g. search).
+ operation (e.g. search). To get a text description of the
+ error, call yaz_error.
Index: phpdoc/en/reference/yaz/functions/yaz-error.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-error.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-error.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-error.xml:1.2 Wed Apr 17 02:45:27 2002
+++ phpdoc/en/reference/yaz/functions/yaz-error.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -10,10 +10,10 @@
Descriptionstringyaz_error
- intid
+ resourceid
- Returns error message for target (last request). An empty string
+ Returns error text message for target (last request). An empty string
is returned if last operation was a success.
Index: phpdoc/en/reference/yaz/functions/yaz-itemorder.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.4
--- phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.3 Sun Dec 1 21:21:13 2002
+++ phpdoc/en/reference/yaz/functions/yaz-itemorder.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -12,6 +12,7 @@
Descriptionintyaz_itemorder
+ resourceidarrayargs
Index: phpdoc/en/reference/yaz/functions/yaz-present.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-present.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-present.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-present.xml:1.2 Wed Apr 17 02:45:27 2002
+++ phpdoc/en/reference/yaz/functions/yaz-present.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -12,7 +12,7 @@
Descriptionintyaz_present
-
+ resourceid
This function prepares for retrieval of records after
Index: phpdoc/en/reference/yaz/functions/yaz-range.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-range.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-range.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-range.xml:1.2 Wed Apr 17 02:45:27 2002
+++ phpdoc/en/reference/yaz/functions/yaz-range.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -12,17 +12,18 @@
Descriptionintyaz_range
- intid
+ resourceidintstartintnumber
- This function is used in conjunction with
- yaz_search to specify the maximum number of
- records to retrieve (number) and the first record position
- (start). If this function is not invoked (only
- yaz_search) start is set to 1 and number is
- set to 10.
+ This function should be called before either
+ yaz_search or yaz_present
+ to specify a range of records to be retrieved.
+ The start specifies position of first record
+ to be retrieved and number is the number
+ records. Records in a result set are numbered 1, 2, ... $hits where
+ $hits is the count returned by yaz_hits.
Returns &true; on success; &false; on error.
Index: phpdoc/en/reference/yaz/functions/yaz-record.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-record.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-record.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-record.xml:1.2 Wed Apr 17 02:45:28 2002
+++ phpdoc/en/reference/yaz/functions/yaz-record.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -9,24 +9,35 @@
Description
- intyaz_record
- intid
+ stringyaz_record
+ resourceidintposstringtype
- Returns record at position or empty string if no record exists at
- given position.
+ Returns record at position pos or empty
+ string if no record exists at given position.
The yaz_record function inspects a record in
the current result set at the position specified. If no database
record exists at the given position an empty string is
- returned. The argument, type, specifies the form of the returned
- record. If type is "string" the record is returned in a string
- representation suitable for printing (for XML and SUTRS). If type
- is "array" the record is returned as an array representation (for
- structured records).
+ returned. The type specifies the form of
+ the returned record.
+
+
+ If type is "string" the record is
+ returned in a string representation suitable for printing
+ (for XML and SUTRS).
+ If type is "array"
+ the record is returned as an array representation (for structured
+ records).
+ If type is "raw" the
+ record is returned in its original raw form.
+
+
+ Records in a result set are numbered 1, 2, ... $hits where
+ $hits is the count returned by yaz_hits.
Index: phpdoc/en/reference/yaz/functions/yaz-scan-result.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.2 Wed Apr 17 02:45:28 2002
+++ phpdoc/en/reference/yaz/functions/yaz-scan-result.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -10,12 +10,13 @@
Descriptionarrayyaz_scan_result
- intid
+ resourceidarray &result
- Given a target ID this function returns and array with terms as received
- from the target in the last Scan Response.
+ yaz_scan_result returns terms and associated
+ information as received from the target in the last performed
+ yaz_scan.
This function returns an array (0..n-1) where n is the number
of terms returned. Each value is a pair where first item is
term, second item is result-count.
Index: phpdoc/en/reference/yaz/functions/yaz-scan.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-scan.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-scan.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-scan.xml:1.2 Wed Apr 17 02:45:28 2002
+++ phpdoc/en/reference/yaz/functions/yaz-scan.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -10,14 +10,14 @@
Descriptionintyaz_scan
- intid
+ resourceidstringtypestringstarttermarrayflags
This function prepares for a Z39.50 Scan Request. Argument
- id specifies target ID. Starting term
+ id specifies connection. Starting term
point for the scan is given by startterm.
The form in which is the starting term is specified is given by
type. Currently type rpn
@@ -44,29 +44,28 @@
PHP function that scans titles
email protected> 1=4 " . $starterm);
- yaz_wait();
- $errno = yaz_errno($id);
- if ($errno == 0) {
- $ar = yaz_scan_result($id,&$options);
- echo 'Scan ok; ';
- $ar = yaz_scan_result($id, &$options);
- while(list($key,$val)=each($options)) {
- echo "$key = $val ";
- }
- echo '
';
+ } else {
+ echo "Scan failed. Error: " . yaz_error($id) . " ";
+ }
+}
]]>
Index: phpdoc/en/reference/yaz/functions/yaz-search.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-search.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-search.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-search.xml:1.2 Wed Apr 17 02:45:28 2002
+++ phpdoc/en/reference/yaz/functions/yaz-search.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -10,15 +10,17 @@
Descriptionintyaz_search
- intid
+ resourceidstringtypestringqueryyaz_search prepares for a search on the
- target with given id. The type represents the query type - only
- "rpn" is supported now in which case the third argument specifies
- a Type-1 query (RPN). Like yaz_connect this
+ connection given by id.
+ The type represents the query type - only
+ "rpn" is supported now in which case the
+ third argument specifies a Type-1 query in prefix query notation.
+ Like yaz_connect this
function is non-blocking and only prepares for a search to be
executed later when yaz_wait is called.
@@ -37,71 +39,94 @@
RPN Operators
+
+
- Syntax
+ ConstructDescription
-
- <email protected> query1 query2
- intersection of query1 and query2
-
-
- <email protected> query1 query2
- union of query1 and query2
-
-
- <email protected> query1 query2
- query1 and not query2
-
-
- <email protected> name
- result set reference
-
-
- <email protected> set query
- specifies attribute-set for query. This construction is only
- allowed once - in the beginning of the whole query
-
-
- <email protected> set type=value query
- applies attribute to query. The type and value are
+
+ <email protected> query1 query2
+ intersection of query1 and query2
+
+
+ <email protected> query1 query2
+ union of query1 and query2
+
+
+ <email protected> query1 query2
+ query1 and not query2
+
+
+ <email protected> name
+ result set reference
+
+
+ <email protected> set query
+ specifies attribute-set for query. This construction is only
+ allowed once - in the beginning of the whole query
+
+
+ <email protected> [set] type=value query
+ applies attribute to query. The type and value are
integers specifying the attribute-type and attribute-value
respectively. The set, if given, specifies the
attribute-set.
-
+
Query Examples
- Query
+ You can search for simple terms, like this
computer
- matches documents where "computer" occur. No attributes are specified.
+ which matches documents where "computer" occur.
+ No attributes are specified.
The Query
- "donald knuth"
- matches documents where "donald knuth" occur.
+ "knuth donald"
+ matches documents where "knuth donald" occur (provided that the
+ server supports phrase search).
+
+
+ This query applies two attributes for the same phrase.
+ <email protected> 1=1003 <email protected> 4=1 "knuth donald"
+ First attribute is type 1 (Bib-1 use), attribute value is 1003
+ (Author).
+ Second attribute has is type 4 (structure), value 1 (phrase),
+ so this should match documents where Donald Knuth is author.
- For the query
- <email protected> 1=4 art
- attribute type is 1 (Bib-1 use), attribute value is 4
- Title), so this should match documents where art
- occur in the title.
+ This query
+ <email protected> <email protected> a b <email protected> <email protected> c d e
+ would in infix notation look like
+ (a or b) and ((c or d) not e).
- Another more complex one:
- <email protected> gils <email protected> <email protected> 1=4 art <email protected> 1=1003 "donald knuth"
+ Another, more complex, one:
+ <email protected> gils <email protected> <email protected> 1=4 art <email protected> 1=2000 company
The query as a whole uses the GILS attributeset. The query matches
- documents where art occur in the title and in which
- donald knuth occur in the author.
+ documents where art occur in the title (GILS,BIB-1)
+ and in which company occur as Distributor (GILS).
+
+ You can find information about attributes at the
+ Z39.50 Maintenance Agency
+ site.
+
+
+
+ If you would like to use a more friendly notation,
+ use the CCL parser - functions yaz_ccl_conf and
+ yaz_ccl_parse.
+
+
Index: phpdoc/en/reference/yaz/functions/yaz-sort.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.2 Wed Apr 17 02:45:28 2002
+++ phpdoc/en/reference/yaz/functions/yaz-sort.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -10,15 +10,16 @@
Descriptionintyaz_sort
- intid
+ resourceidstringcriteria
This function sets sorting criteria and enables Z39.50 Sort.
- Use this function together with yaz_search
- or yaz_present. Using this function alone
- doesn't have any effect. If used in conjunction with
- yaz_search a Z39.50 Sort will be sent after
+ Call this function before
+ yaz_search.
+ Using this function alone doesn't have any effect.
+ When in conjunction with yaz_search,
+ a Z39.50 Sort will be sent after
a search response has been received and before any records are
retrieved with Z39.50 Present. The criteria
takes the form
Index: phpdoc/en/reference/yaz/functions/yaz-syntax.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-syntax.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-syntax.xml:1.3
--- phpdoc/en/reference/yaz/functions/yaz-syntax.xml:1.2 Wed Apr 17 02:45:28 2002
+++ phpdoc/en/reference/yaz/functions/yaz-syntax.xml Thu Jan 16 04:44:49 2003
@@ -1,5 +1,5 @@
-
+
@@ -12,16 +12,15 @@
Descriptionintyaz_syntax
- intid
+ resourceidstringsyntax
- The syntax is specified as an OID (Object Identifier) in a
+ The syntax must be specified as an OID (Object Identifier) in a
raw dot-notation (like 1.2.840.10003.5.10) or
as one of the known registered record syntaxes (sutrs, usmarc, grs1,
- xml, etc.). This function is used in conjunction with
- yaz_search and yaz_present
- to specify the preferred record syntax for retrieval.
+ xml, etc.). This function should be called before
+ yaz_search or yaz_present.
Index: phpdoc/en/reference/yaz/functions/yaz-get-option.xml
+++ phpdoc/en/reference/yaz/functions/yaz-get-option.xml
yaz_get_optionReturns value of option for connectionDescriptionstringyaz_get_optionresourceidstringname
Returns value of option with the name specified.
If option is unset, an empty string is returned.
See description of yaz_set_option for
available options.
Index: phpdoc/en/reference/yaz/functions/yaz-schema.xml
+++ phpdoc/en/reference/yaz/functions/yaz-schema.xml
yaz_schema
Specifies schema for retrieval.
Descriptionintyaz_schemaresourceidstringschema
The schema must be specified as an OID (Object Identifier) in a
raw dot-notation (like 1.2.840.10003.13.4) or
as one of the known registered schemas:
GILS-schema, Holdings,
Zthes, ...
This function should be called before
yaz_search or yaz_present.
Index: phpdoc/en/reference/yaz/functions/yaz-set-option.xml
+++ phpdoc/en/reference/yaz/functions/yaz-set-option.xml
yaz_set_optionSets one or more options for connectionDescriptionstringyaz_set_optionresourceidstringnamestringvalue
Sets option name to value.
PYP/YAZ Connection OptionsNameDescriptionimplementationNameimplementation name of targetimplementationVersionimplementation version of targetimplementationIdimplementation ID of targetschemaschema for retrieval. By default, no
schema is used. Setting this option is equivalent to
using function yaz_schemapreferredRecordSyntaxrecord syntax for retrieval. By default, no
syntax is used. Setting this option is equivalent to
using function yaz_syntaxstartoffset for first record to be retrieved via
yaz_search or yaz_present.
Records are numbered from zero and upwards.
Setting this option in combination with option
count has the same effect as calling
yaz_range except that records are
numbered from 1 in yaz_rangecountmaximum number of records to be retrieved via
yaz_search or yaz_present.
elementSetNameelement-set-name for retrieval. Setting this option is
equivalent to calling yaz_element.