← Back
Editing: sasl_getrealm_t.3
.\" Man page generated from reStructuredText. . .TH "SASL_GETREALM_T" "3" "February 18, 2022" "2.1.28" "Cyrus SASL" .SH NAME sasl_getrealm_t \- Cyrus SASL documentation . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .SH SYNOPSIS .sp .nf #include <sasl/sasl.h> int sasl_getrealm_t(void *context, int id, const char **availrealms, const char **result) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_getrealm_t(void *context, .TP .B int id, .TP .B const char **availrealms, .TP .B const char **result) \fBsasl_getrealm_t()\fP is used when there is an interaction with SASL_CB_GETREALM as the type. .sp If a mechanism would use this callback, but it is not present, then the first realm listed is automatically selected. (Note that a mechanism may still force the existence of a getrealm callback by SASL_CB_GETREALM to its required_prompts list). .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBcontext\fP – context from the callback record .IP \(bu 2 \fBid\fP – callback ID (SASL_CB_GETREALM) .IP \(bu 2 \fBavailrealms\fP – A string list of the available realms. NULL terminated, may be empty. .IP \(bu 2 \fBresult\fP – The chosen realm. (a NUL terminated string) .UNINDENT .UNINDENT .UNINDENT .SH RETURN VALUE .sp SASL callback functions should return SASL return codes. See sasl.h for a complete list. \fBSASL_OK\fP indicates success. .sp Other return codes indicate errors and should be handled. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_callbacks(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .
Save File
Cancel