| author | Jan Parcel <jan.parcel@oracle.com> |
| Thu, 09 Jun 2016 13:52:17 -0700 | |
| changeset 6316 | 351665422d31 |
| parent 5769 | 6303cfed086b |
| permissions | -rw-r--r-- |
|
5055
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
1 |
'\" te |
|
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
2 |
.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy. All Rights Reserved. |
|
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
3 |
.\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved |
|
6316
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
4 |
.TH sasl_client_add_plugin 3sasl "12 Sep 2003" SASL "SASL man pages" |
|
5055
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
5 |
.SH NAME |
|
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
6 |
sasl_client_add_plugin \- add a SASL client plug-in |
|
6316
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
7 |
|
|
5055
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
8 |
.SH SYNOPSIS |
|
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
9 |
.nf |
|
6316
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
10 |
cc [ flag ... ] file ... -lsasl [ library ... ] |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
11 |
.B #include <sasl/saslplug.h> |
|
5055
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
12 |
|
|
6316
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
13 |
.BI " int sasl_client_add_plugin(const char *" plugname ", " |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
14 |
.BI " sasl_client_plug_init_t *" cplugfunc "); " |
|
5055
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
15 |
.fi |
|
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
16 |
|
|
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
17 |
.SH DESCRIPTION |
|
6316
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
18 |
Use the |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
19 |
.B sasl_client_add_plugin() |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
20 |
interface to add a client plug-in to the current in-memory list of client plug-ins in the SASL library. |
|
5055
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
21 |
|
|
6316
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
22 |
.SH PARAMETERS |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
23 |
.I plugname |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
24 |
The name of the client plug-in. |
|
5055
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
25 |
|
|
6316
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
26 |
.I cplugfunc |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
27 |
The value of cplugfunc is filled in by the sasl_client_plug_init_t structure. |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
28 |
|
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
29 |
.SH "RETURN VALUES" |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
30 |
sasl_client_add_plugin() returns an integer that corresponds to a SASL error code. |
|
5055
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
31 |
|
|
6316
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
32 |
.SH ERRORS |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
33 |
.TP 0.8i |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
34 |
.B SASL_OK |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
35 |
The call to sasl_client_add_plugin() was successful. |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
36 |
.TP 0.8i |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
37 |
.B SASL_BADVERS |
|
5055
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
38 |
Version mismatch with plug-in. |
|
6316
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
39 |
.TP 0.8i |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
40 |
.B SASL_NOMEM |
|
5055
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
41 |
Memory shortage failure. |
|
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
42 |
|
|
6316
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
43 |
.TP 0.8i |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
44 |
See sasl_errors(3SASL) for information on other SASL error codes. |
|
5055
9daf220c1a9a
PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff
changeset
|
45 |
|
|
6316
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
46 |
.SH "SEE ALSO" |
|
351665422d31
21773883 Adjust libsasl2 man pages for consistency and to send upstream
Jan Parcel <jan.parcel@oracle.com>
parents:
5769
diff
changeset
|
47 |
sasl_errors(3SASL) |