share/man/man3pam/pam_getenvlist.3pam

   1 '\" te
   2 .\"  Copyright (c) 1998, Sun Microsystems, Inc.   All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH PAM_GETENVLIST 3PAM "Oct 13, 1998"
   7 .SH NAME
   8 pam_getenvlist \- returns a list of all the PAM environment variables
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lpam\fR [ \fIlibrary\fR ... ]
  13 #include <security/pam_appl.h>
  14
  15
  16
  17 \fBchar **\fR\fBpam_getenvlist\fR(\fBpam_handle_t *\fR\fIpamh\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBpam_getenvlist()\fR function returns a list of all the \fBPAM\fR
  24 environment variables stored in the \fBPAM\fR handle \fIpamh\fR. The list is
  25 returned as a null-terminated array of pointers to strings. Each string
  26 contains a single \fBPAM\fR environment variable of the form
  27 \fIname\fR\fB=\fR\fIvalue\fR. The list returned is a duplicate copy of all the
  28 environment variables stored in \fIpamh\fR. It is the responsibility of the
  29 calling application to free the memory returned by \fBpam_getenvlist()\fR.
  30 .SH RETURN VALUES
  31 .sp
  32 .LP
  33 If successful, \fBpam_getenvlist()\fR returns in a null-terminated array a copy
  34 of all the \fBPAM\fR environment variables stored in \fIpamh\fR. Otherwise,
  35 \fBpam_getenvlist()\fR returns a null pointer.
  36 .SH ATTRIBUTES
  37 .sp
  38 .LP
  39 See \fBattributes\fR(5) for descriptions of the following attributes:
  40 .sp
  41
  42 .sp
  43 .TS
  44 box;
  45 c | c
  46 l | l .
  47 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  48 _
  49 Interface Stability      Stable
  50 _
  51 MT-Level        MT-Safe with exceptions
  52 .TE
  53
  54 .SH SEE ALSO
  55 .sp
  56 .LP
  57 \fBpam\fR(3PAM), \fBpam_getenv\fR(3PAM), \fBpam_putenv\fR(3PAM),
  58 \fBlibpam\fR(3LIB), \fBattributes\fR(5)
  59 .SH NOTES
  60 .sp
  61 .LP
  62 The interfaces in  \fBlibpam\fR are MT-Safe only if each thread within the
  63 multithreaded application uses its own \fBPAM\fR handle.