xref: /onnv-gate/usr/src/lib/udapl/libdat/include/dat_dictionary.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright (c) 2002-2003, Network Appliance, Inc. All rights reserved.
24*0Sstevel@tonic-gate  */
25*0Sstevel@tonic-gate 
26*0Sstevel@tonic-gate /*
27*0Sstevel@tonic-gate  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
28*0Sstevel@tonic-gate  * Use is subject to license terms.
29*0Sstevel@tonic-gate  */
30*0Sstevel@tonic-gate 
31*0Sstevel@tonic-gate /*
32*0Sstevel@tonic-gate  *
33*0Sstevel@tonic-gate  * HEADER: dat_dictionary.h
34*0Sstevel@tonic-gate  *
35*0Sstevel@tonic-gate  * PURPOSE: dictionary data structure
36*0Sstevel@tonic-gate  *
37*0Sstevel@tonic-gate  * $Id: dat_dictionary.h,v 1.6 2003/08/05 19:01:48 jlentini Exp $
38*0Sstevel@tonic-gate  */
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate #ifndef _DAT_DICTIONARY_H_
41*0Sstevel@tonic-gate #define	_DAT_DICTIONARY_H_
42*0Sstevel@tonic-gate 
43*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
44*0Sstevel@tonic-gate 
45*0Sstevel@tonic-gate #include <dat_osd.h>
46*0Sstevel@tonic-gate 
47*0Sstevel@tonic-gate #ifdef	__cplusplus
48*0Sstevel@tonic-gate extern "C" {
49*0Sstevel@tonic-gate #endif
50*0Sstevel@tonic-gate 
51*0Sstevel@tonic-gate /*
52*0Sstevel@tonic-gate  *
53*0Sstevel@tonic-gate  * Typedefs
54*0Sstevel@tonic-gate  *
55*0Sstevel@tonic-gate  */
56*0Sstevel@tonic-gate 
57*0Sstevel@tonic-gate typedef struct DAT_DICTIONARY   DAT_DICTIONARY;
58*0Sstevel@tonic-gate typedef	void			*DAT_DICTIONARY_DATA;
59*0Sstevel@tonic-gate typedef	void			*DAT_DICTIONARY_ENTRY;
60*0Sstevel@tonic-gate 
61*0Sstevel@tonic-gate 
62*0Sstevel@tonic-gate /*
63*0Sstevel@tonic-gate  *
64*0Sstevel@tonic-gate  * Function Prototypes
65*0Sstevel@tonic-gate  *
66*0Sstevel@tonic-gate  */
67*0Sstevel@tonic-gate 
68*0Sstevel@tonic-gate extern DAT_RETURN
69*0Sstevel@tonic-gate dat_dictionary_create(
70*0Sstevel@tonic-gate     OUT DAT_DICTIONARY **pp_dictionary);
71*0Sstevel@tonic-gate 
72*0Sstevel@tonic-gate extern DAT_RETURN
73*0Sstevel@tonic-gate dat_dictionary_destroy(
74*0Sstevel@tonic-gate     IN  DAT_DICTIONARY *p_dictionary);
75*0Sstevel@tonic-gate 
76*0Sstevel@tonic-gate extern DAT_RETURN
77*0Sstevel@tonic-gate dat_dictionary_size(
78*0Sstevel@tonic-gate     IN  DAT_DICTIONARY *p_dictionary,
79*0Sstevel@tonic-gate     OUT DAT_COUNT *p_size);
80*0Sstevel@tonic-gate 
81*0Sstevel@tonic-gate extern DAT_RETURN
82*0Sstevel@tonic-gate dat_dictionary_entry_create(
83*0Sstevel@tonic-gate     OUT DAT_DICTIONARY_ENTRY *p_entry);
84*0Sstevel@tonic-gate 
85*0Sstevel@tonic-gate extern DAT_RETURN
86*0Sstevel@tonic-gate dat_dictionary_entry_destroy(
87*0Sstevel@tonic-gate     IN  DAT_DICTIONARY_ENTRY entry);
88*0Sstevel@tonic-gate 
89*0Sstevel@tonic-gate extern DAT_RETURN
90*0Sstevel@tonic-gate dat_dictionary_insert(
91*0Sstevel@tonic-gate     IN  DAT_DICTIONARY *p_dictionary,
92*0Sstevel@tonic-gate     IN  DAT_DICTIONARY_ENTRY entry,
93*0Sstevel@tonic-gate     IN  const DAT_PROVIDER_INFO *key,
94*0Sstevel@tonic-gate     IN  DAT_DICTIONARY_DATA data);
95*0Sstevel@tonic-gate 
96*0Sstevel@tonic-gate extern DAT_RETURN
97*0Sstevel@tonic-gate dat_dictionary_search(
98*0Sstevel@tonic-gate     IN  DAT_DICTIONARY *p_dictionary,
99*0Sstevel@tonic-gate     IN  const DAT_PROVIDER_INFO *key,
100*0Sstevel@tonic-gate     OUT DAT_DICTIONARY_DATA *p_data);
101*0Sstevel@tonic-gate 
102*0Sstevel@tonic-gate extern DAT_RETURN
103*0Sstevel@tonic-gate dat_dictionary_enumerate(
104*0Sstevel@tonic-gate     IN  DAT_DICTIONARY *p_dictionary,
105*0Sstevel@tonic-gate     IN  DAT_DICTIONARY_DATA array[],
106*0Sstevel@tonic-gate     IN  DAT_COUNT array_size);
107*0Sstevel@tonic-gate 
108*0Sstevel@tonic-gate 
109*0Sstevel@tonic-gate extern DAT_RETURN
110*0Sstevel@tonic-gate dat_dictionary_remove(
111*0Sstevel@tonic-gate     IN  DAT_DICTIONARY *p_dictionary,
112*0Sstevel@tonic-gate     IN  DAT_DICTIONARY_ENTRY *p_entry,
113*0Sstevel@tonic-gate     IN  const DAT_PROVIDER_INFO *key,
114*0Sstevel@tonic-gate     OUT DAT_DICTIONARY_DATA *p_data);
115*0Sstevel@tonic-gate 
116*0Sstevel@tonic-gate #ifdef	__cplusplus
117*0Sstevel@tonic-gate }
118*0Sstevel@tonic-gate #endif
119*0Sstevel@tonic-gate 
120*0Sstevel@tonic-gate #endif /* _DAT_DICTIONARY_H_ */
121