sasl_getconfpath_t.3
1 .\" -*- nroff -*- 2 .\" 3 .\" Copyright (c) 2006 Carnegie Mellon University. All rights reserved. 4 .\" 5 .\" Redistribution and use in source and binary forms, with or without 6 .\" modification, are permitted provided that the following conditions 7 .\" are met: 8 .\" 9 .\" 1. Redistributions of source code must retain the above copyright 10 .\" notice, this list of conditions and the following disclaimer. 11 .\" 12 .\" 2. Redistributions in binary form must reproduce the above copyright 13 .\" notice, this list of conditions and the following disclaimer in 14 .\" the documentation and/or other materials provided with the 15 .\" distribution. 16 .\" 17 .\" 3. The name "Carnegie Mellon University" must not be used to 18 .\" endorse or promote products derived from this software without 19 .\" prior written permission. For permission or any other legal 20 .\" details, please contact 21 .\" Office of Technology Transfer 22 .\" Carnegie Mellon University 23 .\" 5000 Forbes Avenue 24 .\" Pittsburgh, PA 15213-3890 25 .\" (412) 268-4387, fax: (412) 268-7395 26 .\" tech-transfer@andrew.cmu.edu 27 .\" 28 .\" 4. Redistributions of any form whatsoever must retain the following 29 .\" acknowledgment: 30 .\" "This product includes software developed by Computing Services 31 .\" at Carnegie Mellon University (http://www.cmu.edu/computing/)." 32 .\" 33 .\" CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO 34 .\" THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 35 .\" AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE 36 .\" FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 37 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN 38 .\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING 39 .\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 40 .\" 41 .TH sasl_getconfpath_t 3 "12 February 2006" SASL "SASL man pages" 42 .SH NAME 43 sasl_getconfpath_t \- The SASL callback to indicate location of the config files 44 45 46 .SH SYNOPSIS 47 .nf 48 .B #include <sasl.h> 49 50 .sp 51 .BI "int sasl_getconfpath_t(void " *context ", " 52 .BI " char ** " path ")"; 53 54 .fi 55 .SH DESCRIPTION 56 57 .B sasl_getconfpath_t 58 is used if the application wishes to use a different location for the SASL configuration files. If this callback is not used SASL will either use the location in the environment variable SASL_CONF_PATH (provided we are not SUID or SGID) or /etc/sasl2 by default. 59 .PP 60 61 .SH "RETURN VALUE" 62 63 SASL callback functions should return SASL return codes. See sasl.h for a complete list. SASL_OK indicates success. 64 65 .SH "CONFORMING TO" 66 RFC 4422 67 .SH "SEE ALSO" 68 sasl(3), sasl_callbacks(3), sasl_errors(3)