man/man3sasl/sasl_getsimple_t.3sasl

     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_GETSIMPLE_T 3SASL "Oct 27, 2003"
 NAME
sasl_getsimple_t - the SASL callback function for username, authname and realm
 SYNOPSIS

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

int sasl_getsimple_t(void *context, int id, const char **result,
 unsigned *len);


 DESCRIPTION

Use the sasl_getsimple_t() callback function to retrieve simple data from
the application such as the authentication name, the authorization name, and
the realm. The id parameter indicates which value is requested.
 PARAMETERS
context

The context from the callback structure.


id

The callback ID. Possible values for id include:
SASL_CB_USER

Client user identity for login.


SASL_CB_AUTHNAME

Client authentication name.


SASL_CB_LANGUAGE

Comma-separated list of languages pursuant to RFC 1766.


SASL_CB_CNONCE

The client-nonce. This value is used primarily for testing.


result

To cancel user, set the value of result with a null-terminated string. If
the value of result is NULL, then the user is cancelled.


len

The length of result.


 RETURN VALUES

Like other SASL callback functions, sasl_getsimple_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_getsimple_t() was successful.


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)
Alvestrand, H. RFC 1766, Tags for the Identification of Languages.
Network Working Group. November 1995.