1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.yaz-sort" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>yaz_sort</refname>
<refpurpose>Sets sorting criteria</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>yaz_sort</methodname>
<methodparam><type>resource</type><parameter>id</parameter></methodparam>
<methodparam><type>string</type><parameter>criteria</parameter></methodparam>
</methodsynopsis>
<para>
This function sets sorting criteria and enables Z39.50 Sort.
</para>
<para>
Call this function <emphasis>before</emphasis> <function>yaz_search</function>.
Using this function alone does not have any effect. When used in conjunction
with <function>yaz_search</function>, a Z39.50 Sort will be sent after a
search response has been received and before any records are retrieved with
Z39.50 Present (<function>yaz_present</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>id</parameter></term>
<listitem>
<para>
The connection resource returned by <function>yaz_connect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>criteria</parameter></term>
<listitem>
<para>
A string that takes the form <replaceable>field1 flags1 field2
flags2</replaceable> where field1 specifies the primary attributes for
sort, field2 seconds, etc..
</para>
<para>
The field specifies either a numerical attribute combinations consisting
of type=value pairs separated by comma (e.g. <literal>1=4,2=1</literal>)
; or the field may specify a plain string criteria (e.g.
<literal>title</literal>. The flags is a sequence of the following
characters which may not be separated by any white space.
</para>
<para>
<variablelist>
<title>Sort Flags</title>
<varlistentry>
<term><literal>a</literal></term>
<listitem>
<para>
Sort ascending
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>d</literal></term>
<listitem>
<para>
Sort descending
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>i</literal></term>
<listitem>
<para>
Case insensitive sorting
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>s</literal></term>
<listitem>
<para>
Case sensitive sorting
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Sort Criterias</title>
<para>
To sort on Bib1 attribute title, case insensitive, and ascending you
would use the following sort criteria:
<screen>
<![CDATA[
1=4 ia
]]>
</screen>
</para>
<para>
If the secondary sorting criteria should be author, case sensitive and
ascending you would use:
<screen>
<![CDATA[
1=4 ia 1=1003 sa
]]>
</screen>
</para>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
