bsd/man/man2/getaudit.2

   1 .\"
   2 .\" Copyright (c) 2007 Apple Inc. All rights reserved.
   3 .\"
   4 .\" @APPLE_OSREFERENCE_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. The rights granted to you under the License
  10 .\" may not be used to create, or enable the creation or redistribution of,
  11 .\" unlawful or unlicensed copies of an Apple operating system, or to
  12 .\" circumvent, violate, or enable the circumvention or violation of, any
  13 .\" terms of an Apple operating system software license agreement.
  14 .\"
  15 .\" Please obtain a copy of the License at
  16 .\" http://www.opensource.apple.com/apsl/ and read it before using this file.
  17 .\"
  18 .\" The Original Code and all software distributed under the License are
  19 .\" distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20 .\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21 .\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22 .\" FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23 .\" Please see the License for the specific language governing rights and
  24 .\" limitations under the License.
  25 .\"
  26 .\" @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27 .\"
  28 .Dd July 30, 2007
  29 .Dt GETAUDIT 2
  30 .Os Darwin
  31 .Sh NAME
  32 .Nm getaudit
  33 .Nd get the audit information for the current process
  34 .Sh SYNOPSIS
  35 .Fd #include <bsm/audit.h>
  36 .Ft int
  37 .Fn getaudit "struct auditinfo * auditinfo"
  38 .Sh DESCRIPTION
  39 The
  40 .Fn getaudit
  41 function returns a
  42 .Fa struct auditinfo
  43 describing the current user audit settings for the calling process. The
  44 information is returned in the struct pointed at by
  45 .Fa auditinfo .
  46 .Sh RETURN VALUES
  47 Upon successful completion a value of 0 is returned.
  48 Otherwise, a value of -1 is returned and
  49 .Va errno
  50 is set to indicate the error.
  51 .Sh SEE ALSO
  52 .Xr audit 2 ,
  53 .Xr auditon 2 ,
  54 .Xr auditctl 2 ,
  55 .Xr getauid 2 ,
  56 .Xr setauid 2 ,
  57 .Xr setaudit 2
  58 .Sh HISTORY
  59 The
  60 .Fn getaudit
  61 function call first appeared in Mac OS X 10.3 (Panther).