Content-type: text/html Man page of sasl_seterror

sasl_seterror

Section: Simple Authentication Security Layer Library Functions (3SASL)
Updated: 14 Oct 2003
Index Return to Main Contents
 

NAME

sasl_seterror - set the error string  

SYNOPSIS

cc [ flag ... ] file ... -lsasl   [ library ... ]
#include <sasl/sasl.h>

void sasl_seterror(sasl_conn_t *conn, unsigned flags, const char *fmt, ...);  

DESCRIPTION

The sasl_seterror() interface sets the error string that will be returned by sasl_errdetail(3SASL). Use syslog(3C) style formatting, that is, use printf()---style with %m as the most recent errno error.

The sasl_seterror() interface is primarily used by server callback functions and internal plug-ins, for example, with the sasl_authorize_t callback. The sasl_seterror() interface triggers a call to the SASL logging callback, if any, with a level of SASL_LOG_FAIL, unless the SASL_NOLOG flag is set.

Make the message string sensitive to the current language setting. If there is no SASL_CB_LANGUAGE callback, message strings must be i-default. Otherwise, UTF-8 is used. Use of RFC 2482 for mixed-language text is encouraged.

If the value of conn is NULL, the sasl_seterror() interface fails.  

PARAMETERS

conn The sasl_conn_t for which the call to sasl_seterror() applies.

flags If set to SASL_NOLOG, the call to sasl_seterror() is not logged.

fmt A syslog(3C) style format string.

 

RETURN VALUES

sasl_seterror() has no return values.  

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
AvailabilitySUNWlibsasl
Interface StabilityEvolving
MT-LevelMT-Safe

 

SEE ALSO

sasl_errdetail(3SASL), syslog(3C), attributes(5)

Whistler, K. and Adams, G. RFC 2482, Language Tagging in Unicode Plain Text. Network Working Group. January 1999.


 

Index

NAME
SYNOPSIS
DESCRIPTION
PARAMETERS
RETURN VALUES
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:39:13 GMT, October 02, 2010