xref: /titanic_52/usr/src/man/man3sasl/sasl_getrealm_t.3sasl (revision 89b43686db1fe9681d80a7cf5662730cb9378cae) 
 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_getrealm_t 3SASL "27 Oct 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
 NAME
sasl_getrealm_t - the realm acquisition callback function

 SYNOPSIS


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

int sasl_getrealm_t(void *context, int id, const char **availrealms,
 const char **result);




 DESCRIPTION

Use the sasl_getrealm_t() functionwhen there is an interaction with
SASL_CB_GETREALM as the type.


If a mechanism would use this callback, but it is not present, then the first
realm listed is automatically selected. A mechanism can still force the
existence of a getrealm callback by SASL_CB_GETREALM to its
required_prompts list.

 PARAMETERS

context


The context from the callback record





id


The callback ID (SASL_CB_GETREALM)





availrealms


A string list of the vailable realms. availrealms is a null-terminated
sting that can be empty.





result


The chosen realm. result is a null-terminated string.




 RETURN VALUES

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





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

 ATTRIBUTES

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







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-Safe



 SEE ALSO

sasl_errors(3SASL), attributes(5)