3 * $Id: netg.h,v 1.2 1997/08/20 16:19:24 mdw Exp $
5 * A local database of netgroups
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of `become'
14 * `Become' is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * `Become' is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with `become'; if not, write to the Free Software Foundation,
26 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 /*----- Revision history --------------------------------------------------*
32 * Revision 1.2 1997/08/20 16:19:24 mdw
33 * Replace `name_reinit' by `name_end' for more sensible restart.
35 * Revision 1.1 1997/08/07 09:45:00 mdw
36 * New source file added to maintain a netgroups database.
47 /*----- Required headers --------------------------------------------------*/
53 /*----- Type definitions --------------------------------------------------*/
55 typedef sym_iter netg_iter;
56 typedef struct netg__sym netg;
58 /*----- Functions provided ------------------------------------------------*/
60 /* --- @netg_iterate@, @netg_iterate_r@ --- *
62 * Arguments: @netg_iter *i@ = pointer to a netgroup iterator object
66 * Use: Starts iterating over the netgroups.
69 extern void netg_iterate(void);
70 extern void netg_iterate_r(netg_iter */*i*/);
72 /* --- @netg_next@, @netg_next_r@ --- *
74 * Arguments: @netg_iter *i@ = pointer to a netgroup iterator object
76 * Returns: An opaque pointer to the next item, or null.
78 * Use: Returns the next netgroup.
81 extern netg *netg_next(void);
82 extern netg *netg_next_r(netg_iter */*i*/);
84 /* --- @netg_name@ --- *
86 * Arguments: @netg *n@ = netgroup handle returned by @netg_next@.
88 * Returns: A pointer to the name; you may not modify this string.
90 * Use: Returns the name of a netgroup.
93 extern const char *netg_name(netg */*n*/);
95 /* --- @netg_scan@ --- *
97 * Arguments: @netg *n@ = a netgroup handle returned by @netg_next@
98 * @int (*proc)(netg *n, const char *host, const char *user,@
99 * @const char *domain, void *ctx)@ = function to call
101 * @void *ctx@ = context pointer to pass to @proc@.
103 * Returns: Zero if all went well, or the nonzero return value from
106 * Use: Passes all the members of the netgroup to a given function.
107 * The function is given the names, directly from the NIS
108 * netgroup map, except that any empty entries are passed as
109 * null pointers rather than empty strings. You may not modify
110 * any of the strings. The enumeration function, @proc@, may
111 * return nonzero to stop itself from being called any more;
112 * if this happens, the value it returns becomes the result of
113 * this function. If all the items are enumerated OK, this
114 * function returns zero.
117 extern int netg_scan(netg */*n*/,
118 int (*/*proc*/)(netg */*n*/, const char */*host*/,
119 const char */*user*/,
120 const char */*domain*/, void */*ctx*/),
123 /* --- @netg_init@ --- *
129 * Use: Reads the netgroup database and turns it into something nice.
132 extern void netg_init(void);
134 /* --- @netg_end@ --- *
140 * Use: Empties the netgroups database.
143 extern void netg_end(void);
145 /*----- That's all, folks -------------------------------------------------*/