← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/cyrus-sasl2/gutsy-201105300151

« back to all changes in this revision

Viewing changes to man/sasl_getrealm_t.3

  • Committer: Bazaar Package Importer
  • Author(s): Scott James Remnant
  • Date: 2006-11-27 12:59:40 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20061127125940-na3q3g3tkydvyvgl
Tags: 2.1.22.dfsg1-4ubuntu1
* Merge from debian unstable, remaining changes:
  - remove stop links from rc0 and rc6
  - build against db4.3 instead of 4.2
  - build against heimdal-dev instead of libkrb5-dev
  - depend on, don't recommend, modules

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/sasl_getrealm_t.3
 
1
.\" -*- nroff -*-
 
2
.\" 
 
3
.\" Copyright (c) 2001 Carnegie Mellon University.  All rights reserved.
 
4
.\"
 
5
.\" Redistribution and use in source and binary forms, with or without
 
6
.\" modification, are permitted provided that the following conditions
 
7
.\" are met:
 
8
.\"
 
9
.\" 1. Redistributions of source code must retain the above copyright
 
10
.\"    notice, this list of conditions and the following disclaimer. 
 
11
.\"
 
12
.\" 2. Redistributions in binary form must reproduce the above copyright
 
13
.\"    notice, this list of conditions and the following disclaimer in
 
14
.\"    the documentation and/or other materials provided with the
 
15
.\"    distribution.
 
16
.\"
 
17
.\" 3. The name "Carnegie Mellon University" must not be used to
 
18
.\"    endorse or promote products derived from this software without
 
19
.\"    prior written permission. For permission or any other legal
 
20
.\"    details, please contact  
 
21
.\"      Office of Technology Transfer
 
22
.\"      Carnegie Mellon University
 
23
.\"      5000 Forbes Avenue
 
24
.\"      Pittsburgh, PA  15213-3890
 
25
.\"      (412) 268-4387, fax: (412) 268-7395
 
26
.\"      tech-transfer@andrew.cmu.edu
 
27
.\"
 
28
.\" 4. Redistributions of any form whatsoever must retain the following
 
29
.\"    acknowledgment:
 
30
.\"    "This product includes software developed by Computing Services
 
31
.\"     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
 
32
.\"
 
33
.\" CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
 
34
.\" THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 
35
.\" AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
 
36
.\" FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 
37
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
 
38
.\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 
39
.\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
40
.\" 
 
41
.TH sasl_getrealm_t "10 July 2001" SASL "SASL man pages"
 
42
.SH NAME
 
43
sasl_getrealm_t \- Realm Acquisition Callback
 
44
 
 
45
.SH SYNOPSIS
 
46
.nf
 
47
.B #include <sasl/sasl.h>
 
48
 
 
49
.sp
 
50
.BI "int sasl_getrealm_t(void " *context ", int " id ", "
 
51
.BI "                    const char " **availrealms ","
 
52
.BI "                    const char " **result ")"
 
53
 
 
54
.fi
 
55
.SH DESCRIPTION
 
56
 
 
57
.B sasl_getrealm_t
 
58
is used when there is an interaction with SASL_CB_GETREALM as the type.
 
59
 
 
60
If a mechanism would use this callback, but it is not present, then the first
 
61
realm listed is automatically selected.  (Note that a mechanism may still
 
62
force the existence of a getrealm callback by SASL_CB_GETREALM to its
 
63
required_prompts list).
 
64
 
 
65
.I context
 
66
context from the callback record
 
67
 
 
68
.I id
 
69
callback ID (SASL_CB_GETREALM)
 
70
 
 
71
.I availrealms
 
72
A string list of the available realms.  NULL terminated, may be empty.
 
73
 
 
74
.I result
 
75
The chosen realm. (a NUL terminated string)
 
76
 
 
77
.SH "RETURN VALUE"
 
78
SASL callback functions should return SASL return codes. See sasl.h for a complete list. SASL_OK indicates success.
 
79
 
 
80
.SH "SEE ALSO"
 
81
sasl(3), sasl_callbacks(3)