File: sasl_getpath_t.rst.txt

package info (click to toggle)
cyrus-sasl2 2.1.27%2Bdfsg-2.1%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 19,940 kB
  • sloc: ansic: 58,942; javascript: 8,745; sh: 4,843; java: 1,614; xml: 1,498; makefile: 1,265; python: 342; perl: 199
file content (43 lines) | stat: -rw-r--r-- 1,173 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
.. saslman:: sasl_getpath_t(3)

.. _sasl-reference-manpages-library-sasl_getpath_t:


====================================================================================
**sasl_getpath_t** - The SASL callback to indicate location of the mechanism drivers
====================================================================================

Synopsis
========

.. code-block:: C

    #include <sasl/sasl.h>

    int sasl_getpath_t(void *context,
                      char ** path);

Description
===========

.. c:function:: int sasl_getpath_t(void *context, char ** path);

    **sasl_getpath_t()** is used if the application wishes to use  a
    different  location  for  the  SASL mechanism drivers (the
    shared library files). If this callback is not used SASL
    will either use the location in the environment variable
    SASL_PATH or `/usr/lib/sasl2` by default.


Return Value
============

SASL  callback  functions should return SASL return codes.
See sasl.h for a complete list. :c:macro:`SASL_OK` indicates success.

Other return codes indicate errors and should be handled.

See Also
========

:rfc:`4422`,:saslman:`sasl(3)`, :saslman:`sasl_callbacks(3)`