usr/src/man/man3sasl/sasl_seterror.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_SETERROR 3SASL "Oct 14, 2003"
   9 .SH NAME
  10 sasl_seterror \- set the error string
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/sasl.h>
  16
  17 \fBvoid\fR \fBsasl_seterror\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBunsigned\fR \fIflags\fR,
  18      \fBconst char *\fR\fIfmt\fR, ...);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBsasl_seterror()\fR interface sets the error string that will be returned
  25 by \fBsasl_errdetail\fR(3SASL). Use \fBsyslog\fR(3C) style formatting, that is,
  26 use \fBprintf()\fR\(emstyle with \fB%m\fR as the most recent \fBerrno\fR error.
  27 .sp
  28 .LP
  29 The \fBsasl_seterror()\fR interface is primarily used by server callback
  30 functions and internal plug-ins, for example, with the \fBsasl_authorize_t\fR
  31 callback. The \fBsasl_seterror()\fR interface triggers a call to the SASL
  32 logging callback, if any, with a level of \fBSASL_LOG_FAIL\fR, unless the
  33 \fBSASL_NOLOG\fR flag is set.
  34 .sp
  35 .LP
  36 Make the message string sensitive to the current language setting. If there is
  37 no \fBSASL_CB_LANGUAGE\fR callback, message strings must be \fBi-default\fR.
  38 Otherwise, UTF-8 is used. Use of \fIRFC 2482\fR for mixed-language text is
  39 encouraged.
  40 .sp
  41 .LP
  42 If the value of \fIconn\fR is \fINULL\fR, the \fBsasl_seterror()\fR interface
  43 fails.
  44 .SH PARAMETERS
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIconn\fR\fR
  49 .ad
  50 .RS 9n
  51 The \fBsasl_conn_t\fR for which the call to \fBsasl_seterror()\fR applies.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fIflags\fR\fR
  58 .ad
  59 .RS 9n
  60 If set to \fBSASL_NOLOG\fR, the call to \fBsasl_seterror()\fR is not logged.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fIfmt\fR\fR
  67 .ad
  68 .RS 9n
  69 A \fBsyslog\fR(3C) style format string.
  70 .RE
  71
  72 .SH RETURN VALUES
  73 .sp
  74 .LP
  75 \fBsasl_seterror()\fR has no return values.
  76 .SH ATTRIBUTES
  77 .sp
  78 .LP
  79 See \fBattributes\fR(5) for descriptions of the following attributes:
  80 .sp
  81
  82 .sp
  83 .TS
  84 box;
  85 c | c
  86 l | l .
  87 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  88 _
  89 Interface Stability     Evolving
  90 _
  91 MT-Level        MT-Safe
  92 .TE
  93
  94 .SH SEE ALSO
  95 .sp
  96 .LP
  97 \fBsasl_errdetail\fR(3SASL), \fBsyslog\fR(3C), \fBattributes\fR(5)
  98 .sp
  99 .LP
 100 Whistler, K. and Adams, G. \fIRFC 2482, Language Tagging in Unicode Plain
 101 Text\fR. Network Working Group. January 1999.