File: sasl_utf8verify.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 (47 lines) | stat: -rw-r--r-- 1,124 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
44
45
46
47
.. saslman:: sasl_utf8verify(3)

.. _sasl-reference-manpages-library-sasl_utf8verify:


===================================================
**sasl_utf8verify** - Verify a string is valid utf8
===================================================

Synopsis
========

.. code-block:: C

    #include <sasl/saslutil.h>

    int sasl_utf8verify(const char *str,
                        unsigned len);

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

.. c:function:: int sasl_utf8verify(const char *str,
        unsigned len);

    Use the **sasl_utf8verify** interface to verify that a string is
    valid UTF‐8 and does not contain NULL, a carriage return, or a linefeed.
    If len == 0, strlen(str) will be used.

    :param str: A string.

    :param len: The length of the string. If len == 0, strlen(str) will be used.

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

SASL 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.

* :c:macro:`SASL_BADPROT`: There was invalid UTF8, or an error was found.

See Also
========

:saslman:`sasl_errors(3)`