xref: /illumos-gate/usr/src/man/man3sasl/sasl_getcallback_t.3sasl (revision 2a8bcb4efb45d99ac41c94a75c396b362c414f7f)
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_GETCALLBACK_T 3SASL "Oct 27, 2003"
NAME
sasl_getcallback_t - callback function to lookup a sasl_callback_t for a connection
SYNOPSIS

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

int sasl_getcallback_t(sasl_conn_t *conn, unsigned long callbacknum,
 int (**proc)( ), void **pcontext);
DESCRIPTION

The sasl_getcallback_t() function is a callback to lookup a sasl_callback_t for a connection.

PARAMETERS
conn

The connection to lookup a callback for.

callbacknum

The number of the callback.

proc

Pointer to the callback function. The value of proc is set to NULL upon failure.

pcontext

Pointer to the callback context. The value of pcontext is set to NULL upon failure.

RETURN VALUES

Like other SASL callback functions, sasl_getcallback_t() returns an integer that corresponds to a SASL error code. See <sasl.h> for a complete list of SASL error codes.

ERRORS
SASL_OK

The call to sasl_getcallback_t() was successful.

SASL_FAIL

Unable to find a callback of the requested type.

SASL_INTERACT

The caller must use interaction to get data.

See sasl_errors(3SASL) for information on SASL error codes.

ATTRIBUTES

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

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

sasl_errors (3SASL), attributes (7)