src/uss/uss_ptserver.h

   1 /*
   2  * Copyright 2000, International Business Machines Corporation and others.
   3  * All Rights Reserved.
   4  *
   5  * This software has been released under the terms of the IBM Public
   6  * License.  For details, see the LICENSE file in the top-level source
   7  * directory or online at http://www.openafs.org/dl/license10.html
   8  */
   9
  10 /*
  11  *      Interface to the basic procedures for the AFS user account
  12  *      facility.
  13  */
  14
  15 #ifndef _USS_PTSERVER_H_
  16 #define _USS_PTSERVER_H_ 1
  17
  18 /*
  19  * --------------------- Required definitions ---------------------
  20  */
  21 #include "uss_common.h"         /*Commons uss definitions */
  22
  23
  24 /*
  25  * ------------------------ Exported functions  -----------------------
  26  */
  27 extern afs_int32 uss_ptserver_AddUser(char *a_user, char *a_uid);
  28     /*
  29      * Summary:
  30      *    Register the given user with the Protection Server.
  31      *
  32      * Args:
  33      *    char *a_user : Name of the user to register.
  34      *    char *a_uid  : Points to the uid registered for the named user.
  35      *
  36      * Returns:
  37      *    0         if everything went well,
  38      *    PRIDEXIST if the chosen uid already exists, or
  39      *    Code returned from a lower-level call.
  40      */
  41
  42 extern afs_int32 uss_ptserver_DelUser(char *a_name);
  43     /*
  44      * Summary:
  45      *    Delete the given user from the Protection Server.
  46      *
  47      * Args:
  48      *    char *a_name : User name to delete.
  49      *
  50      * Returns:
  51      *    0         if everything went well, or
  52      *    Code returned from a lower-level call.
  53      */
  54
  55 extern afs_int32 uss_ptserver_XlateUser(char *a_user, afs_int32 *a_uidP);
  56     /*
  57      * Summary:
  58      *    Ask the Protection Server to translate the given user
  59      *    name to its corresponding AFS uid.
  60      *
  61      * Args:
  62      *    char *a_user  : Name of the user to translate.
  63      *    afs_int32 *a_uidP  : Points to the uid registered for the named user.
  64      *
  65      * Returns:
  66      *    0         if everything went well,
  67      *    Code returned from a lower-level call.
  68      */
  69
  70 #endif /* _USS_PTSERVER_H_ */