YAZ  4.2.57
z-exp.h
Go to the documentation of this file.
1 
7 #ifndef z_exp_H
8 #define z_exp_H
9 
10 #include <yaz/odr.h>
11 #include <yaz/z-core.h>
12 #ifdef __cplusplus
13 extern "C" {
14 #endif
15 
17 YAZ_EXPORT int z_ExplainRecord(ODR o, Z_ExplainRecord **p, int opt, const char *name);
18 
19 typedef struct Z_TargetInfo Z_TargetInfo;
20 YAZ_EXPORT int z_TargetInfo(ODR o, Z_TargetInfo **p, int opt, const char *name);
21 
23 YAZ_EXPORT int z_DatabaseInfo(ODR o, Z_DatabaseInfo **p, int opt, const char *name);
24 
26 YAZ_EXPORT int z_TagTypeMapping(ODR o, Z_TagTypeMapping **p, int opt, const char *name);
27 
28 typedef struct Z_SchemaInfo Z_SchemaInfo;
29 YAZ_EXPORT int z_SchemaInfo(ODR o, Z_SchemaInfo **p, int opt, const char *name);
30 
32 YAZ_EXPORT int z_ElementInfo(ODR o, Z_ElementInfo **p, int opt, const char *name);
33 
34 typedef struct Z_PathUnit Z_PathUnit;
35 YAZ_EXPORT int z_PathUnit(ODR o, Z_PathUnit **p, int opt, const char *name);
36 
37 typedef struct Z_Path Z_Path;
38 YAZ_EXPORT int z_Path(ODR o, Z_Path **p, int opt, const char *name);
39 
41 YAZ_EXPORT int z_ElementInfoList(ODR o, Z_ElementInfoList **p, int opt, const char *name);
42 
44 YAZ_EXPORT int z_ElementDataType(ODR o, Z_ElementDataType **p, int opt, const char *name);
45 
47 YAZ_EXPORT int z_PrimitiveDataType(ODR o, Z_PrimitiveDataType **p, int opt, const char *name);
48 
50 YAZ_EXPORT int z_TagSetElements(ODR o, Z_TagSetElements **p, int opt, const char *name);
51 
52 typedef struct Z_TagSetInfo Z_TagSetInfo;
53 YAZ_EXPORT int z_TagSetInfo(ODR o, Z_TagSetInfo **p, int opt, const char *name);
54 
56 YAZ_EXPORT int z_RecordSyntaxInfo(ODR o, Z_RecordSyntaxInfo **p, int opt, const char *name);
57 
59 YAZ_EXPORT int z_AttributeSetInfo(ODR o, Z_AttributeSetInfo **p, int opt, const char *name);
60 
62 YAZ_EXPORT int z_AttributeType(ODR o, Z_AttributeType **p, int opt, const char *name);
63 
65 YAZ_EXPORT int z_AttributeDescription(ODR o, Z_AttributeDescription **p, int opt, const char *name);
66 
68 YAZ_EXPORT int z_TermListElement(ODR o, Z_TermListElement **p, int opt, const char *name);
69 
71 YAZ_EXPORT int z_TermListInfo(ODR o, Z_TermListInfo **p, int opt, const char *name);
72 
74 YAZ_EXPORT int z_ExtendedServicesInfo(ODR o, Z_ExtendedServicesInfo **p, int opt, const char *name);
75 
77 YAZ_EXPORT int z_AttributeDetails(ODR o, Z_AttributeDetails **p, int opt, const char *name);
78 
80 YAZ_EXPORT int z_AttributeSetDetails(ODR o, Z_AttributeSetDetails **p, int opt, const char *name);
81 
83 YAZ_EXPORT int z_AttributeTypeDetails(ODR o, Z_AttributeTypeDetails **p, int opt, const char *name);
84 
86 YAZ_EXPORT int z_OmittedAttributeInterpretation(ODR o, Z_OmittedAttributeInterpretation **p, int opt, const char *name);
87 
89 YAZ_EXPORT int z_AttributeValue(ODR o, Z_AttributeValue **p, int opt, const char *name);
90 
91 typedef struct Z_EScanInfo Z_EScanInfo;
92 YAZ_EXPORT int z_EScanInfo(ODR o, Z_EScanInfo **p, int opt, const char *name);
93 
95 YAZ_EXPORT int z_TermListDetails(ODR o, Z_TermListDetails **p, int opt, const char *name);
96 
98 YAZ_EXPORT int z_ElementSetDetails(ODR o, Z_ElementSetDetails **p, int opt, const char *name);
99 
101 YAZ_EXPORT int z_RetrievalRecordDetails(ODR o, Z_RetrievalRecordDetails **p, int opt, const char *name);
102 
104 YAZ_EXPORT int z_PerElementDetails(ODR o, Z_PerElementDetails **p, int opt, const char *name);
105 
106 typedef struct Z_RecordTag Z_RecordTag;
107 YAZ_EXPORT int z_RecordTag(ODR o, Z_RecordTag **p, int opt, const char *name);
108 
110 YAZ_EXPORT int z_SortDetails(ODR o, Z_SortDetails **p, int opt, const char *name);
111 
113 YAZ_EXPORT int z_SortKeyDetails(ODR o, Z_SortKeyDetails **p, int opt, const char *name);
114 
116 YAZ_EXPORT int z_ProcessingInformation(ODR o, Z_ProcessingInformation **p, int opt, const char *name);
117 
119 YAZ_EXPORT int z_VariantSetInfo(ODR o, Z_VariantSetInfo **p, int opt, const char *name);
120 
122 YAZ_EXPORT int z_VariantClass(ODR o, Z_VariantClass **p, int opt, const char *name);
123 
125 YAZ_EXPORT int z_VariantType(ODR o, Z_VariantType **p, int opt, const char *name);
126 
128 YAZ_EXPORT int z_VariantValue(ODR o, Z_VariantValue **p, int opt, const char *name);
129 
131 YAZ_EXPORT int z_ValueSetEnumerated(ODR o, Z_ValueSetEnumerated **p, int opt, const char *name);
132 
133 typedef struct Z_ValueSet Z_ValueSet;
134 YAZ_EXPORT int z_ValueSet(ODR o, Z_ValueSet **p, int opt, const char *name);
135 
136 typedef struct Z_ValueRange Z_ValueRange;
137 YAZ_EXPORT int z_ValueRange(ODR o, Z_ValueRange **p, int opt, const char *name);
138 
140 YAZ_EXPORT int z_ValueDescription(ODR o, Z_ValueDescription **p, int opt, const char *name);
141 
142 typedef struct Z_UnitInfo Z_UnitInfo;
143 YAZ_EXPORT int z_UnitInfo(ODR o, Z_UnitInfo **p, int opt, const char *name);
144 
145 typedef struct Z_UnitType Z_UnitType;
146 YAZ_EXPORT int z_UnitType(ODR o, Z_UnitType **p, int opt, const char *name);
147 
148 typedef struct Z_Units Z_Units;
149 YAZ_EXPORT int z_Units(ODR o, Z_Units **p, int opt, const char *name);
150 
152 YAZ_EXPORT int z_CategoryList(ODR o, Z_CategoryList **p, int opt, const char *name);
153 
155 YAZ_EXPORT int z_CategoryInfo(ODR o, Z_CategoryInfo **p, int opt, const char *name);
156 
157 typedef struct Z_CommonInfo Z_CommonInfo;
158 YAZ_EXPORT int z_CommonInfo(ODR o, Z_CommonInfo **p, int opt, const char *name);
159 
161 YAZ_EXPORT int z_HumanStringUnit(ODR o, Z_HumanStringUnit **p, int opt, const char *name);
162 
164 YAZ_EXPORT int z_HumanString(ODR o, Z_HumanString **p, int opt, const char *name);
165 
167 YAZ_EXPORT int z_IconObjectUnit(ODR o, Z_IconObjectUnit **p, int opt, const char *name);
168 
169 typedef struct Z_IconObject Z_IconObject;
170 YAZ_EXPORT int z_IconObject(ODR o, Z_IconObject **p, int opt, const char *name);
171 
173 YAZ_EXPORT int z_LanguageCode(ODR o, Z_LanguageCode **p, int opt, const char *name);
174 
176 YAZ_EXPORT int z_ContactInfo(ODR o, Z_ContactInfo **p, int opt, const char *name);
177 
179 YAZ_EXPORT int z_NetworkAddressIA(ODR o, Z_NetworkAddressIA **p, int opt, const char *name);
180 
182 YAZ_EXPORT int z_NetworkAddressOPA(ODR o, Z_NetworkAddressOPA **p, int opt, const char *name);
183 
185 YAZ_EXPORT int z_NetworkAddressOther(ODR o, Z_NetworkAddressOther **p, int opt, const char *name);
186 
188 YAZ_EXPORT int z_NetworkAddress(ODR o, Z_NetworkAddress **p, int opt, const char *name);
189 
190 typedef struct Z_AccessInfo Z_AccessInfo;
191 YAZ_EXPORT int z_AccessInfo(ODR o, Z_AccessInfo **p, int opt, const char *name);
192 
194 YAZ_EXPORT int z_QueryTypeDetails(ODR o, Z_QueryTypeDetails **p, int opt, const char *name);
195 
197 YAZ_EXPORT int z_PrivateCapOperator(ODR o, Z_PrivateCapOperator **p, int opt, const char *name);
198 
200 YAZ_EXPORT int z_PrivateCapabilities(ODR o, Z_PrivateCapabilities **p, int opt, const char *name);
201 
203 YAZ_EXPORT int z_RpnCapabilities(ODR o, Z_RpnCapabilities **p, int opt, const char *name);
204 
206 YAZ_EXPORT int z_Iso8777Capabilities(ODR o, Z_Iso8777Capabilities **p, int opt, const char *name);
207 
209 YAZ_EXPORT int z_ProxSupportPrivate(ODR o, Z_ProxSupportPrivate **p, int opt, const char *name);
210 
212 YAZ_EXPORT int z_ProxSupportUnit(ODR o, Z_ProxSupportUnit **p, int opt, const char *name);
213 
215 YAZ_EXPORT int z_ProximitySupport(ODR o, Z_ProximitySupport **p, int opt, const char *name);
216 
217 typedef struct Z_SearchKey Z_SearchKey;
218 YAZ_EXPORT int z_SearchKey(ODR o, Z_SearchKey **p, int opt, const char *name);
219 
221 YAZ_EXPORT int z_AccessRestrictionsUnit(ODR o, Z_AccessRestrictionsUnit **p, int opt, const char *name);
222 
224 YAZ_EXPORT int z_AccessRestrictions(ODR o, Z_AccessRestrictions **p, int opt, const char *name);
225 
227 YAZ_EXPORT int z_CostsOtherCharge(ODR o, Z_CostsOtherCharge **p, int opt, const char *name);
228 
229 typedef struct Z_Costs Z_Costs;
230 YAZ_EXPORT int z_Costs(ODR o, Z_Costs **p, int opt, const char *name);
231 
232 typedef struct Z_Charge Z_Charge;
233 YAZ_EXPORT int z_Charge(ODR o, Z_Charge **p, int opt, const char *name);
234 
236 YAZ_EXPORT int z_DatabaseList(ODR o, Z_DatabaseList **p, int opt, const char *name);
237 
239 YAZ_EXPORT int z_AttributeCombinations(ODR o, Z_AttributeCombinations **p, int opt, const char *name);
240 
242 YAZ_EXPORT int z_AttributeCombination(ODR o, Z_AttributeCombination **p, int opt, const char *name);
243 
245 YAZ_EXPORT int z_AttributeValueList(ODR o, Z_AttributeValueList **p, int opt, const char *name);
246 
248 YAZ_EXPORT int z_AttributeOccurrence(ODR o, Z_AttributeOccurrence **p, int opt, const char *name);
249 #ifdef __cplusplus
250 }
251 #endif
252 #ifdef __cplusplus
253 extern "C" {
254 #endif
256  int which;
257  union {
275 #define Z_Explain_targetInfo 1
276 #define Z_Explain_databaseInfo 2
277 #define Z_Explain_schemaInfo 3
278 #define Z_Explain_tagSetInfo 4
279 #define Z_Explain_recordSyntaxInfo 5
280 #define Z_Explain_attributeSetInfo 6
281 #define Z_Explain_termListInfo 7
282 #define Z_Explain_extendedServicesInfo 8
283 #define Z_Explain_attributeDetails 9
284 #define Z_Explain_termListDetails 10
285 #define Z_Explain_elementSetDetails 11
286 #define Z_Explain_retrievalRecordDetails 12
287 #define Z_Explain_sortDetails 13
288 #define Z_Explain_processing 14
289 #define Z_Explain_variants 15
290 #define Z_Explain_units 16
291 #define Z_Explain_categoryList 17
292  } u;
293 };
294 
295 struct Z_TargetInfo {
299  Z_IconObject *icon; /* OPT */
302  Odr_int *maxResultSets; /* OPT */
303  Odr_int *maxResultSize; /* OPT */
304  Odr_int *maxTerms; /* OPT */
313  Z_HumanString *hours; /* OPT */
321 };
322 
329  Z_IconObject *icon; /* OPT */
334  Z_HumanString **keywords; /* OPT */
337  Z_DatabaseList *subDbs; /* OPT */
339  Z_HumanString *news; /* OPT */
340  int which;
341  union {
344 #define Z_DatabaseInfo_actualNumber 1
345 #define Z_DatabaseInfo_approxNumber 2
346  } u; /* OPT */
348  Odr_int *avRecordSize; /* OPT */
349  Odr_int *maxRecordSize; /* OPT */
350  Z_HumanString *hours; /* OPT */
352  char *lastUpdate; /* OPT */
355  Odr_bool *proprietary; /* OPT */
362 };
363 
366  Odr_oid *tagSet; /* OPT */
368 };
369 
370 struct Z_SchemaInfo {
379 };
380 
388 };
389 
390 struct Z_PathUnit {
393 };
394 
395 struct Z_Path {
396  int num;
398 };
399 
401  int num;
403 };
404 
406  int which;
407  union {
410 #define Z_ElementDataType_primitive 1
411 #define Z_ElementDataType_structured 2
412  } u;
413 };
414 
415 #define Z_PrimitiveDataType_octetString 0
416 #define Z_PrimitiveDataType_numeric 1
417 #define Z_PrimitiveDataType_date 2
418 #define Z_PrimitiveDataType_external 3
419 #define Z_PrimitiveDataType_string 4
420 #define Z_PrimitiveDataType_trueOrFalse 5
421 #define Z_PrimitiveDataType_oid 6
422 #define Z_PrimitiveDataType_intUnit 7
423 #define Z_PrimitiveDataType_empty 8
424 #define Z_PrimitiveDataType_noneOfTheAbove 100
425 
434 };
435 
436 struct Z_TagSetInfo {
443 };
444 
455 };
456 
464 };
465 
472 };
473 
480 };
481 
484  Z_HumanString *title; /* OPT */
485 #define Z_TermListElement_optimized 0
486 #define Z_TermListElement_normal 1
487 #define Z_TermListElement_expensive 2
488 #define Z_TermListElement_filter 3
489  Odr_int *searchCost; /* OPT */
495 };
496 
502 };
503 
513 #define Z_ExtendedServicesInfo_waitSupported 1
514 #define Z_ExtendedServicesInfo_waitAlways 2
515 #define Z_ExtendedServicesInfo_waitNotSupported 3
516 #define Z_ExtendedServicesInfo_depends 4
517 #define Z_ExtendedServicesInfo_notSaying 5
522 };
523 
530 };
531 
536 };
537 
543 };
544 
548 };
549 
558 };
559 
560 struct Z_EScanInfo {
561  Odr_int *maxStepSize; /* OPT */
563  Odr_bool *increasing; /* OPT */
564 };
565 
571  Z_EScanInfo *scanInfo; /* OPT */
574  Z_Term **sampleTerms; /* OPT */
575 };
576 
586 };
587 
596 };
597 
600  Z_RecordTag *recordTag; /* OPT */
602  Z_Path **schemaTags; /* OPT */
603  Odr_int *maxSize; /* OPT */
604  Odr_int *minSize; /* OPT */
605  Odr_int *avgSize; /* OPT */
606  Odr_int *fixedSize; /* OPT */
618 };
619 
620 struct Z_RecordTag {
623 };
624 
630 };
631 
637  int which;
638  union {
642 #define Z_SortKeyDetails_character 1
643 #define Z_SortKeyDetails_numeric 2
644 #define Z_SortKeyDetails_structured 3
645  } u; /* OPT */
646 #define Z_SortKeyDetails_always 0
647 #define Z_SortKeyDetails_never 1
648 #define Z_SortKeyDetails_default_yes 2
649 #define Z_SortKeyDetails_default_no 3
651 };
652 
656 #define Z_ProcessingInformation_access 0
657 #define Z_ProcessingInformation_search 1
658 #define Z_ProcessingInformation_retrieval 2
659 #define Z_ProcessingInformation_record_presentation 3
660 #define Z_ProcessingInformation_record_handling 4
666 };
667 
674 };
675 
682 };
683 
689 };
690 
693  Z_ValueSet *values; /* OPT */
694 };
695 
697  int num;
699 };
700 
701 struct Z_ValueSet {
702  int which;
703  union {
706 #define Z_ValueSet_range 1
707 #define Z_ValueSet_enumerated 2
708  } u;
709 };
710 
711 struct Z_ValueRange {
714 };
715 
717  int which;
718  union {
725 #define Z_ValueDescription_integer 1
726 #define Z_ValueDescription_string 2
727 #define Z_ValueDescription_octets 3
728 #define Z_ValueDescription_oid 4
729 #define Z_ValueDescription_unit 5
730 #define Z_ValueDescription_valueAndUnit 6
731  } u;
732 };
733 
734 struct Z_UnitInfo {
739  Z_UnitType **units; /* OPT */
740 };
741 
742 struct Z_UnitType {
748 };
749 
750 struct Z_Units {
754 };
755 
760 };
761 
767 };
768 
769 struct Z_CommonInfo {
770  char *dateAdded; /* OPT */
771  char *dateChanged; /* OPT */
772  char *expiry; /* OPT */
775 };
776 
780 };
781 
785 };
786 
788  int which;
789  union {
793 #define Z_IconObjectUnit_ianaType 1
794 #define Z_IconObjectUnit_z3950type 2
795 #define Z_IconObjectUnit_otherType 3
796  } u;
798 };
799 
800 struct Z_IconObject {
801  int num;
803 };
804 
805 
806 
810  Z_HumanString *address; /* OPT */
813 };
814 
818 };
819 
825 };
826 
830 };
831 
833  int which;
834  union {
838 #define Z_NetworkAddress_iA 1
839 #define Z_NetworkAddress_oPA 2
840 #define Z_NetworkAddress_other 3
841  } u;
842 };
843 
844 struct Z_AccessInfo {
852  Odr_oid **schemas; /* OPT */
854  Odr_oid **recordSyntaxes; /* OPT */
858  Z_Costs *costInfo; /* OPT */
860  Odr_oid **variantSets; /* OPT */
865 };
866 
868  int which;
869  union {
876 #define Z_QueryTypeDetails_private 1
877 #define Z_QueryTypeDetails_rpn 2
878 #define Z_QueryTypeDetails_iso8777 3
879 #define Z_QueryTypeDetails_z39_58 4
880 #define Z_QueryTypeDetails_erpn 5
881 #define Z_QueryTypeDetails_rankedList 6
882  } u;
883 };
884 
888 };
889 
894  Z_SearchKey **searchKeys; /* OPT */
897 };
898 
901  Odr_int **operators; /* OPT */
905 };
906 
911 };
912 
916 };
917 
919  int which;
920  union {
923 #define Z_ProxSupportUnit_known 1
924 #define Z_ProxSupportUnit_private 2
925  } u;
926 };
927 
932 };
933 
934 struct Z_SearchKey {
937 };
938 
940 #define Z_AccessRestrictionsUnit_any 0
941 #define Z_AccessRestrictionsUnit_search 1
942 #define Z_AccessRestrictionsUnit_present 2
943 #define Z_AccessRestrictionsUnit_specific_elements 3
944 #define Z_AccessRestrictionsUnit_extended_services 4
945 #define Z_AccessRestrictionsUnit_by_database 5
950 };
951 
953  int num;
955 };
956 
960 };
961 
962 struct Z_Costs {
964  Z_Charge *connectTime; /* OPT */
966  Z_Charge *searchCharge; /* OPT */
970 };
971 
972 struct Z_Charge {
974  Z_Unit *perWhat; /* OPT */
975  Z_HumanString *text; /* OPT */
976 };
977 
981 };
982 
987 };
988 
992 };
993 
997 };
998 
1003  int which;
1004  union {
1007 #define Z_AttributeOcc_any_or_none 1
1008 #define Z_AttributeOcc_specific 2
1009  } attributeValues;
1010 };
1011 
1012 #ifdef __cplusplus
1013 }
1014 #endif
1015 #endif