/*
- * Copyright (c) 1995-2002, Index Data.
+ * Copyright (C) 1995-2005, Index Data ApS
*
* Permission to use, copy, modify, distribute, and sell this software and
* its documentation, in whole or in part, for any purpose, is hereby granted,
* LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
* OF THIS SOFTWARE.
*
+ * $Id: prt-ext.h,v 1.12 2005-01-27 09:08:42 adam Exp $
+ */
+
+/**
+ * \file prt-ext.h
+ * \brief Header for utilities that handles Z39.50 EXTERNALs
*/
/*
YAZ_BEGIN_CDECL
-/*
+/**
* Used to keep track of known External definitions (a loose approach
* to DEFINED_BY).
*/
-
typedef struct Z_ext_typeent
{
oid_value dref; /* the direct-reference OID value. */
Odr_fun fun; /* decoder function */
} Z_ext_typeent;
+/** \brief structure for all known EXTERNALs */
struct Z_External
{
Odr_oid *direct_reference;
#define Z_External_acfDes1 24
#define Z_External_acfKrb1 25
#define Z_External_multisrch2 26
+#define Z_External_CQL 27
+#define Z_External_OCLCUserInfo 28
union
{
/* Generic types */
Z_KRBObject *acfKrb1;
Z_MultipleSearchTerms_2 *multipleSearchTerms_2;
+ Z_InternationalString *cql;
+ Z_OCLC_UserInformation *oclc;
} u;
};
+/** \brief codec for BER EXTERNAL */
YAZ_EXPORT int z_External(ODR o, Z_External **p, int opt, const char *name);
+/** \brief returns type information for OID (NULL if not known) */
YAZ_EXPORT Z_ext_typeent *z_ext_getentbyref(oid_value val);
+/** \brief encodes EXTERNAL record based on OID (NULL if knot known) */
YAZ_EXPORT Z_External *z_ext_record(ODR o, int format, const char *buf,
int len);