genericopenlibs/openenvcore/include/grp.dosc
changeset 0 e4d67989cc36
equal deleted inserted replaced
-1:000000000000 0:e4d67989cc36
       
     1 /** @file ../include/grp.h
       
     2 @internalComponent
       
     3 */
       
     4 
       
     5 /** @fn  endgrent(void)
       
     6 
       
     7 Refer to  getgrent() for the documentation
       
     8 
       
     9 
       
    10  
       
    11 
       
    12 @publishedAll
       
    13 @externallyDefinedApi
       
    14 */
       
    15 
       
    16 /** @fn  *getgrent(void)
       
    17 
       
    18 Note: This description also covers the following functions -
       
    19  getgrnam()  getgrnam_r()  getgrgid()  getgrgid_r()  setgroups()  setgrent()  endgrent() 
       
    20  
       
    21 
       
    22 
       
    23 @code
       
    24 
       
    25 @endcode
       
    26   These APIs are build supported but not available functionally. Symbian OS 
       
    27 does not support multiple users and groups.
       
    28 
       
    29 
       
    30  
       
    31 
       
    32 @publishedAll
       
    33 @externallyDefinedApi
       
    34 */
       
    35 
       
    36 /** @fn  *getgrgid(gid_t gid)
       
    37 @param gid
       
    38 Refer to  getgrent() for the documentation
       
    39 
       
    40 @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.) 
       
    41 The setgrent return the value 1 if successful, otherwise the value 0 is returned. The endgrent API has no return value. 
       
    42 
       
    43  
       
    44 
       
    45 @publishedAll
       
    46 @externallyDefinedApi
       
    47 */
       
    48 
       
    49 /** @fn  *getgrnam(const char *)
       
    50 
       
    51 Refer to  getgrent() for the documentation
       
    52 
       
    53 
       
    54  
       
    55 
       
    56 @publishedAll
       
    57 @externallyDefinedApi
       
    58 */
       
    59 
       
    60 /** @fn  setgrent(void)
       
    61 
       
    62 Refer to  getgrent() for the documentation
       
    63 
       
    64 
       
    65  
       
    66 
       
    67 @publishedAll
       
    68 @externallyDefinedApi
       
    69 */
       
    70 
       
    71 /** @fn  getgrgid_r(gid_t gid, struct group *grp, char *, size_t, struct group **result)
       
    72 @param gid
       
    73 @param grp
       
    74 @param result
       
    75 Refer to  getgrent() for the documentation
       
    76 
       
    77 
       
    78  
       
    79 
       
    80 @publishedAll
       
    81 @externallyDefinedApi
       
    82 */
       
    83 
       
    84 /** @fn  getgrnam_r(const char *name, struct group *grp, char *, size_t, struct group **result)
       
    85 @param name
       
    86 @param grp
       
    87 @param result
       
    88 
       
    89 Refer to  getgrent() for the documentation
       
    90 
       
    91 
       
    92  
       
    93 
       
    94 @publishedAll
       
    95 @externallyDefinedApi
       
    96 */
       
    97 
       
    98 /** @struct group 
       
    99 
       
   100 Includes the following members,
       
   101 
       
   102 @publishedAll
       
   103 @externallyDefinedApi
       
   104 */
       
   105 
       
   106 /** @var group::gr_name
       
   107 group name
       
   108 */
       
   109 
       
   110 /** @var group::gr_passwd
       
   111 group password
       
   112 */
       
   113 
       
   114 /** @var group::gr_gid
       
   115 group id
       
   116 */
       
   117 
       
   118 /** @var group::gr_mem
       
   119 group members
       
   120 */
       
   121 
       
   122 /** @def _PATH_GROUP
       
   123 @publishedAll
       
   124 @released
       
   125 */