share/man/man3sasl/sasl_getpath_t.3sasl

   1 '\" te
   2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems,
   4 .\" Inc. All Rights Reserved
   5 .\" 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.
   6 .\" 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.
   7 .\" 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]
   8 .TH SASL_GETPATH_T 3SASL "Oct 27, 2003"
   9 .SH NAME
  10 sasl_getpath_t \- the SASL callback function to indicate location of the
  11 security mechanism drivers
  12 .SH SYNOPSIS
  13 .LP
  14 .nf
  15 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  16 #include <sasl/sasl.h>
  17
  18 \fBint\fR \fBsasl_getpath_t\fR(\fBvoid *\fR\fIcontext\fR, \fBchar **\fR\fIpath\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 Use the \fBsasl_getpath_t()\fR function to enable the application to use a
  25 different location for the SASL security mechanism drivers, which are shared
  26 library files. If the \fBsasl_getpath_t()\fR callback is not used, SASL uses
  27 \fB/usr/lib/sasl\fR by default.
  28 .SH PARAMETERS
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIcontext\fR\fR
  33 .ad
  34 .RS 11n
  35 The getpath context from the callback record
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fIpath\fR\fR
  42 .ad
  43 .RS 11n
  44 The path(s) for the location of the SASL security mechanism drivers. The values
  45 for \fIpath\fR are colon-separated.
  46 .RE
  47
  48 .SH RETURN VALUES
  49 .sp
  50 .LP
  51 Like other SASL callback functions, \fBsasl_getpath_t()\fR returns an integer
  52 that corresponds to a SASL error code. See <\fBsasl.h\fR> for a complete list
  53 of SASL error codes.
  54 .SH ERRORS
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBSASL_OK\fR\fR
  59 .ad
  60 .RS 11n
  61 The call to \fBsasl_getpath_t()\fR was successful.
  62 .RE
  63
  64 .sp
  65 .LP
  66 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
  67 .SH ATTRIBUTES
  68 .sp
  69 .LP
  70 See \fBattributes\fR(5) for descriptions of the following attributes:
  71 .sp
  72
  73 .sp
  74 .TS
  75 box;
  76 c | c
  77 l | l .
  78 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  79 _
  80 Interface Stability     Evolving
  81 _
  82 MT-Level        MT-Safe
  83 .TE
  84
  85 .SH SEE ALSO
  86 .sp
  87 .LP
  88 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)