man/sasl_errstring.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2001 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_errstring "10 July 2001" SASL "SASL man pages"
  42 .SH NAME
  43 sasl_errstring \- Translate a SASL return code to a human-readable form
  44
  45
  46 .SH SYNOPSIS
  47 .nf
  48 .B #include <sasl/sasl.h>
  49
  50 .sp
  51 .BI "const char * sasl_errstring(int " saslerr ", "
  52 .BI "                           const char * " langlist ", "
  53 .BI "                           const char ** " outlang ");"
  54
  55 .fi
  56 .SH DESCRIPTION
  57
  58 .B sasl_usererr
  59 is called to convert a SASL return code (an integer) into a human
  60 readable string. At this time the only language available is american
  61 english written by programmers (aka gobbledygook).
  62 Note that a server should call sasl_usererr on a return code first if
  63 the string is going to be sent to the client.
  64 .PP
  65 .I saslerr
  66 specifies the error number to convert.
  67 .PP
  68 .I langlist
  69 is currently unused; Use NULL.
  70 .PP
  71 .I outlang
  72 specifies the desired RFC 1766 language for output.  NULL defaults to "en-us,"
  73 currently the only supported language.
  74 .PP
  75 It should be noted that this function is not the recommended means of
  76 extracting error code information from SASL, instead application should
  77 use sasl_errdetail(3), which contains this information (and more)
  78 .PP
  79 .SH "RETURN VALUE"
  80 Returns the string.  If langlist is NULL, US-ASCII is used.
  81 .PP
  82 .SH "CONFORMING TO"
  83 RFC 2222
  84 .SH "SEE ALSO"
  85 sasl(3), sasl_errdetail(3), sasl_errors(3)