bsd/man/man2/getauid.2

   1 .\"
   2 .\" Copyright (c) 2007 Apple Inc. All rights reserved.
   3 .\"
   4 .\" @APPLE_LICENSE_HEADER_START@
   5 .\"
   6 .\" This file contains Original Code and/or Modifications of Original Code
   7 .\" as defined in and that are subject to the Apple Public Source License
   8 .\" Version 2.0 (the 'License'). You may not use this file except in
   9 .\" compliance with the License. Please obtain a copy of the License at
  10 .\" http://www.opensource.apple.com/apsl/ and read it before using this
  11 .\" file.
  12 .\"
  13 .\" The Original Code and all software distributed under the License are
  14 .\" distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15 .\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16 .\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17 .\" FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18 .\" Please see the License for the specific language governing rights and
  19 .\" limitations under the License.
  20 .\"
  21 .\" @APPLE_LICENSE_HEADER_END@
  22 .\"
  23 .Dd July 30, 2007
  24 .Dt GETAUID 2
  25 .Os Darwin
  26 .Sh NAME
  27 .Nm getauid
  28 .Nd get the audit user ID of the current process
  29 .Sh SYNOPSIS
  30 .Fd #include <bsm/audit.h>
  31 .Ft int
  32 .Fn getauid "au_id_t * auid"
  33 .Sh DESCRIPTION
  34 The
  35 .Fn getauid
  36 function returns the audit user ID for the calling process. The variable pointed
  37 at by
  38 .Fa auid
  39 holds the ID returned by the system.
  40 .Sh RETURN VALUES
  41 Upon successful completion a value of 0 is returned.
  42 Otherwise, a value of -1 is returned and
  43 .Va errno
  44 is set to indicate the error.
  45 .Sh SEE ALSO
  46 .Xr audit 2 ,
  47 .Xr auditon 2 ,
  48 .Xr auditctl 2 ,
  49 .Xr setauid 2 ,
  50 .Xr getaudit 2 ,
  51 .Xr setaudit 2
  52 .Sh HISTORY
  53 The
  54 .Fn getauid
  55 function call first appeared in Mac OS X 10.3 (Panther).