include/aliases.h

   1 /* Copyright (C) 1996-2021 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   4    The GNU C Library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Lesser General Public
   6    License as published by the Free Software Foundation; either
   7    version 2.1 of the License, or (at your option) any later version.
   8
   9    The GNU C Library is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Lesser General Public License for more details.
  13
  14    You should have received a copy of the GNU Lesser General Public
  15    License along with the GNU C Library; if not, see
  16    <https://www.gnu.org/licenses/>.  */
  17
  18 #ifndef _ALIASES_H
  19 #define _ALIASES_H      1
  20
  21 #include <features.h>
  22
  23 #include <sys/types.h>
  24
  25
  26 __BEGIN_DECLS
  27
  28 /* Structure to represent one entry of the alias database.  */
  29 struct aliasent
  30   {
  31     char *alias_name;
  32     size_t alias_members_len;
  33     char **alias_members;
  34     int alias_local;
  35   };
  36
  37
  38 /* Open alias data base files.  */
  39 extern void setaliasent (void) __THROW;
  40
  41 /* Close alias database files.  */
  42 extern void endaliasent (void) __THROW;
  43
  44 /* Get the next entry from the alias database.  */
  45 extern struct aliasent *getaliasent (void) __THROW;
  46
  47 /* Get the next entry from the alias database and put it in RESULT_BUF.  */
  48 extern int getaliasent_r (struct aliasent *__restrict __result_buf,
  49                           char *__restrict __buffer, size_t __buflen,
  50                           struct aliasent **__restrict __result) __THROW;
  51
  52 /* Get alias entry corresponding to NAME.  */
  53 extern struct aliasent *getaliasbyname (const char *__name) __THROW;
  54
  55 /* Get alias entry corresponding to NAME and put it in RESULT_BUF.  */
  56 extern int getaliasbyname_r (const char *__restrict __name,
  57                              struct aliasent *__restrict __result_buf,
  58                              char *__restrict __buffer, size_t __buflen,
  59                              struct aliasent **__restrict __result) __THROW;
  60
  61 __END_DECLS
  62
  63 #endif /* aliases.h */