1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2009 Index Data.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Index Data nor the names of its contributors
13 * may be used to endorse or promote products derived from this
14 * software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 * \brief Header for OID basic functions
35 #include <yaz/yconfig.h>
40 #define OID_STR_MAX 256
42 typedef short Odr_oid; /* terminate by -1 */
44 typedef enum oid_proto
56 \param t destination OID
59 YAZ_EXPORT void oid_oidcpy(Odr_oid *t, const Odr_oid *s);
61 /** \brief appends to OID
62 \param t destination OID
65 YAZ_EXPORT void oid_oidcat(Odr_oid *t, const Odr_oid *s);
68 /** \brief compares OIDs
72 \retval >0 o1 greater than o2
73 \retval <0 o1 less than o2
75 YAZ_EXPORT int oid_oidcmp(const Odr_oid *o1, const Odr_oid *o2);
78 /** \brief returns length of OIDs
80 \returns length as number of Odr_oids
82 YAZ_EXPORT int oid_oidlen(const Odr_oid *o);
84 /** \brief converts OID to string (dot notation)
86 \param oidbuf resulting buffer which should be at least of size OID_STR_MAX
87 \returns result (same as oidbuf)
89 YAZ_EXPORT char *oid_oid_to_dotstring(const Odr_oid *oid, char *oidbuf);
92 /** \brief converts dot string to OID
93 \param name dot string OID, e.g. "1.2.840.10003.2.1"
94 \param oid resulting OID buffer which should be at least of size OID_SIZE
98 YAZ_EXPORT int oid_dotstring_to_oid(const char *name, Odr_oid *oid);
106 * c-file-style: "Stroustrup"
107 * indent-tabs-mode: nil
109 * vim: shiftwidth=4 tabstop=8 expandtab