xref: /illumos-gate/usr/src/man/man3sasl/sasl_errdetail.3sasl (revision ed093b41a93e8563e6e1e5dae0768dda2a7bcc27)
te
Copyright (C) 1998-2003, Carnegie Mellon Univeristy. All Rights Reserved.
Portions Copyright (C) 2003, Sun Microsystems,
Inc. All Rights Reserved
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.
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.
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]
SASL_ERRDETAIL 3SASL "Oct 14, 2003"
NAME
sasl_errdetail - retrieve detailed information about an error
SYNOPSIS

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

const char * sasl_errdetail(sasl_conn_t *conn);
DESCRIPTION

The sasl_errdetail() interface returns an internationalized string that is a message that describes the error that occurred on a SASL connection. The sasl_errdetail() interface provides a more user friendly error message than the SASL error code returned when SASL indicates that an error has occurred on a connection. See sasl_errors(3SASL).

PARAMETERS
conn

The SASL connection context for which the inquiry is made.

RETURN VALUES

sasl_errdetail() returns the string that describes the error that occurred, or NULL, if there was an error retrieving it.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level Safe
SEE ALSO

sasl_errors (3SASL), sasl_seterror (3SASL), attributes (7)