Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id B5C81200C17 for ; Thu, 5 Jan 2017 20:51:15 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id B4701160B42; Thu, 5 Jan 2017 19:51:15 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id B7E3F160B4E for ; Thu, 5 Jan 2017 20:51:13 +0100 (CET) Received: (qmail 5327 invoked by uid 500); 5 Jan 2017 19:51:12 -0000 Mailing-List: contact commits-help@apr.apache.org; run by ezmlm Precedence: bulk List-Post: List-Help: List-Unsubscribe: Reply-To: dev@apr.apache.org List-Id: Delivered-To: mailing list commits@apr.apache.org Received: (qmail 5164 invoked by uid 99); 5 Jan 2017 19:51:12 -0000 Received: from Unknown (HELO svn01-us-west.apache.org) (209.188.14.144) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 05 Jan 2017 19:51:12 +0000 Received: from svn01-us-west.apache.org (localhost [127.0.0.1]) by svn01-us-west.apache.org (ASF Mail Server at svn01-us-west.apache.org) with ESMTP id 0130E3A3B09 for ; Thu, 5 Jan 2017 19:51:11 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1777502 [8/8] - in /apr/site/trunk/docs/docs/apr/1.6: ./ search/ Date: Thu, 05 Jan 2017 19:51:09 -0000 To: commits@apr.apache.org From: jim@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20170105195111.0130E3A3B09@svn01-us-west.apache.org> archived-at: Thu, 05 Jan 2017 19:51:15 -0000 Modified: apr/site/trunk/docs/docs/apr/1.6/group__apr__user.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/1.6/group__apr__user.html?rev=1777502&r1=1777501&r2=1777502&view=diff ============================================================================== --- apr/site/trunk/docs/docs/apr/1.6/group__apr__user.html (original) +++ apr/site/trunk/docs/docs/apr/1.6/group__apr__user.html Thu Jan 5 19:51:08 2017 @@ -77,20 +77,115 @@ var searchBox = new SearchBox("searchBox
User and Group ID Services
+ + + + + +

+Macros

#define apr_uid_compare(left, right)   (((left) == (right)) ? APR_SUCCESS : APR_EMISMATCH)
 
#define apr_gid_compare(left, right)   (((left) == (right)) ? APR_SUCCESS : APR_EMISMATCH)
 
+

Typedefs

typedef uid_t apr_uid_t
 
typedef gid_t apr_gid_t
 
+ + + + + + + + + + + + +

+Functions

apr_status_t apr_uid_current (apr_uid_t *userid, apr_gid_t *groupid, apr_pool_t *p)
 
apr_status_t apr_uid_name_get (char **username, apr_uid_t userid, apr_pool_t *p)
 
apr_status_t apr_uid_get (apr_uid_t *userid, apr_gid_t *groupid, const char *username, apr_pool_t *p)
 
apr_status_t apr_uid_homepath_get (char **dirname, const char *username, apr_pool_t *p)
 
apr_status_t apr_gid_name_get (char **groupname, apr_gid_t groupid, apr_pool_t *p)
 
apr_status_t apr_gid_get (apr_gid_t *groupid, const char *groupname, apr_pool_t *p)
 

Detailed Description

+

Macro Definition Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
#define apr_gid_compare( left,
 right 
)   (((left) == (right)) ? APR_SUCCESS : APR_EMISMATCH)
+
+

Compare two group identifiers for equality.

Parameters
+ + + +
leftOne gid to test
rightAnother gid to test
+
+
+
Returns
APR_SUCCESS if the apr_gid_t structures identify the same group, APR_EMISMATCH if not, APR_BADARG if an apr_gid_t is invalid.
+
Remarks
This function is available only if APR_HAS_USER is defined.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
#define apr_uid_compare( left,
 right 
)   (((left) == (right)) ? APR_SUCCESS : APR_EMISMATCH)
+
+

Compare two user identifiers for equality.

Parameters
+ + + +
leftOne uid to test
rightAnother uid to test
+
+
+
Returns
APR_SUCCESS if the apr_uid_t structures identify the same user, APR_EMISMATCH if not, APR_BADARG if an apr_uid_t is invalid.
+
Remarks
This function is available only if APR_HAS_USER is defined.
+ +
+

Typedef Documentation

@@ -118,6 +213,260 @@ Typedefs
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
apr_status_t apr_gid_get (apr_gid_tgroupid,
const char * groupname,
apr_pool_tp 
)
+
+

Get the groupid for a specified group name

Parameters
+ + + + +
groupidPointer to the group id (on output)
groupnameThe group name to look up
pThe pool from which to allocate the string
+
+
+
Remarks
This function is available only if APR_HAS_USER is defined.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
apr_status_t apr_gid_name_get (char ** groupname,
apr_gid_t groupid,
apr_pool_tp 
)
+
+

Get the group name for a specified groupid

Parameters
+ + + + +
groupnamePointer to new string containing group name (on output)
groupidThe groupid
pThe pool from which to allocate the string
+
+
+
Remarks
This function is available only if APR_HAS_USER is defined.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
apr_status_t apr_uid_current (apr_uid_tuserid,
apr_gid_tgroupid,
apr_pool_tp 
)
+
+

Get the userid (and groupid) of the calling process

Parameters
+ + + + +
useridReturns the user id
groupidReturns the user's group id
pThe pool from which to allocate working space
+
+
+
Remarks
This function is available only if APR_HAS_USER is defined.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
apr_status_t apr_uid_get (apr_uid_tuserid,
apr_gid_tgroupid,
const char * username,
apr_pool_tp 
)
+
+

Get the userid (and groupid) for the specified username

Parameters
+ + + + + +
useridReturns the user id
groupidReturns the user's group id
usernameThe username to look up
pThe pool from which to allocate working space
+
+
+
Remarks
This function is available only if APR_HAS_USER is defined.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
apr_status_t apr_uid_homepath_get (char ** dirname,
const char * username,
apr_pool_tp 
)
+
+

Get the home directory for the named user

Parameters
+ + + + +
dirnamePointer to new string containing directory name (on output)
usernameThe named user
pThe pool from which to allocate the string
+
+
+
Remarks
This function is available only if APR_HAS_USER is defined.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
apr_status_t apr_uid_name_get (char ** username,
apr_uid_t userid,
apr_pool_tp 
)
+
+

Get the user name for a specified userid

Parameters
+ + + + +
usernamePointer to new string containing user name (on output)
useridThe userid
pThe pool from which to allocate the string
+
+
+
Remarks
This function is available only if APR_HAS_USER is defined.
+ +
+