1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/ossrv/genericopenlibs/openenvcore/include/grp.dosc	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,125 @@
     1.4 +/** @file ../include/grp.h
     1.5 +@internalComponent
     1.6 +*/
     1.7 +
     1.8 +/** @fn  endgrent(void)
     1.9 +
    1.10 +Refer to  getgrent() for the documentation
    1.11 +
    1.12 +
    1.13 + 
    1.14 +
    1.15 +@publishedAll
    1.16 +@externallyDefinedApi
    1.17 +*/
    1.18 +
    1.19 +/** @fn  *getgrent(void)
    1.20 +
    1.21 +Note: This description also covers the following functions -
    1.22 + getgrnam()  getgrnam_r()  getgrgid()  getgrgid_r()  setgroups()  setgrent()  endgrent() 
    1.23 + 
    1.24 +
    1.25 +
    1.26 +@code
    1.27 +
    1.28 +@endcode
    1.29 +  These APIs are build supported but not available functionally. Symbian OS 
    1.30 +does not support multiple users and groups.
    1.31 +
    1.32 +
    1.33 + 
    1.34 +
    1.35 +@publishedAll
    1.36 +@externallyDefinedApi
    1.37 +*/
    1.38 +
    1.39 +/** @fn  *getgrgid(gid_t gid)
    1.40 +@param gid
    1.41 +Refer to  getgrent() for the documentation
    1.42 +
    1.43 +@return The functions getgrent, getgrnam, and getgrgid, return a pointer to a group structure on success or NULL if the entry is not found or if an error occurs. If an error does occur, errno will be set. The functions getgrnam_r and getgrgid_r return 0 if no error occurred, or an error number to indicate failure. It is not an error if a matching entry is not found. (Thus, if result is set to NULL and the return value is 0, no matching entry exists.) 
    1.44 +The setgrent return the value 1 if successful, otherwise the value 0 is returned. The endgrent API has no return value. 
    1.45 +
    1.46 + 
    1.47 +
    1.48 +@publishedAll
    1.49 +@externallyDefinedApi
    1.50 +*/
    1.51 +
    1.52 +/** @fn  *getgrnam(const char *)
    1.53 +
    1.54 +Refer to  getgrent() for the documentation
    1.55 +
    1.56 +
    1.57 + 
    1.58 +
    1.59 +@publishedAll
    1.60 +@externallyDefinedApi
    1.61 +*/
    1.62 +
    1.63 +/** @fn  setgrent(void)
    1.64 +
    1.65 +Refer to  getgrent() for the documentation
    1.66 +
    1.67 +
    1.68 + 
    1.69 +
    1.70 +@publishedAll
    1.71 +@externallyDefinedApi
    1.72 +*/
    1.73 +
    1.74 +/** @fn  getgrgid_r(gid_t gid, struct group *grp, char *, size_t, struct group **result)
    1.75 +@param gid
    1.76 +@param grp
    1.77 +@param result
    1.78 +Refer to  getgrent() for the documentation
    1.79 +
    1.80 +
    1.81 + 
    1.82 +
    1.83 +@publishedAll
    1.84 +@externallyDefinedApi
    1.85 +*/
    1.86 +
    1.87 +/** @fn  getgrnam_r(const char *name, struct group *grp, char *, size_t, struct group **result)
    1.88 +@param name
    1.89 +@param grp
    1.90 +@param result
    1.91 +
    1.92 +Refer to  getgrent() for the documentation
    1.93 +
    1.94 +
    1.95 + 
    1.96 +
    1.97 +@publishedAll
    1.98 +@externallyDefinedApi
    1.99 +*/
   1.100 +
   1.101 +/** @struct group 
   1.102 +
   1.103 +Includes the following members,
   1.104 +
   1.105 +@publishedAll
   1.106 +@externallyDefinedApi
   1.107 +*/
   1.108 +
   1.109 +/** @var group::gr_name
   1.110 +group name
   1.111 +*/
   1.112 +
   1.113 +/** @var group::gr_passwd
   1.114 +group password
   1.115 +*/
   1.116 +
   1.117 +/** @var group::gr_gid
   1.118 +group id
   1.119 +*/
   1.120 +
   1.121 +/** @var group::gr_mem
   1.122 +group members
   1.123 +*/
   1.124 +
   1.125 +/** @def _PATH_GROUP
   1.126 +@publishedAll
   1.127 +@released
   1.128 +*/