equal
deleted
inserted
replaced
|
1 '\" te |
|
2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy. All Rights Reserved. |
|
3 .\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved |
|
4 .TH sasl_utf8verify 3SASL "1 Oct 2003" "SunOS 5.12" "Simple Authentication Security Layer Library Functions" |
|
5 .SH NAME |
|
6 sasl_utf8verify \- encode base64 string |
|
7 .SH SYNOPSIS |
|
8 .LP |
|
9 .nf |
|
10 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR [ \fIlibrary\fR ... ] |
|
11 #include <sasl/saslutil.h> |
|
12 |
|
13 \fBint\fR \fBsasl_utf8verify\fR(\fBconst char *\fR\fIstr\fR, \fBunsigned\fR \fIlen\fR); |
|
14 .fi |
|
15 |
|
16 .SH DESCRIPTION |
|
17 .sp |
|
18 .LP |
|
19 Use the \fBsasl_utf8verify()\fR interface to verify that a string is valid UTF-8 and does not contain \fINULL\fR, a carriage return, or a linefeed. If \fIlen\fR ==0, \fBstrlen\fR(\fIstr\fR) will be used. |
|
20 .SH PARAMETERS |
|
21 .sp |
|
22 .ne 2 |
|
23 .mk |
|
24 .na |
|
25 \fB\fIstr\fR\fR |
|
26 .ad |
|
27 .RS 7n |
|
28 .rt |
|
29 A string |
|
30 .RE |
|
31 |
|
32 .sp |
|
33 .ne 2 |
|
34 .mk |
|
35 .na |
|
36 \fB\fIlen\fR\fR |
|
37 .ad |
|
38 .RS 7n |
|
39 .rt |
|
40 The length of the string |
|
41 .RE |
|
42 |
|
43 .SH RETURN VALUES |
|
44 .sp |
|
45 .LP |
|
46 \fBsasl_utf8verify()\fR returns an integer that corresponds to a SASL error code. |
|
47 .SH ERRORS |
|
48 .sp |
|
49 .ne 2 |
|
50 .mk |
|
51 .na |
|
52 \fB\fBSASL_OK\fR\fR |
|
53 .ad |
|
54 .RS 16n |
|
55 .rt |
|
56 The call to \fBsasl_utf8verify()\fR was successful. |
|
57 .RE |
|
58 |
|
59 .sp |
|
60 .ne 2 |
|
61 .mk |
|
62 .na |
|
63 \fB\fBSASL_BADPROT\fR\fR |
|
64 .ad |
|
65 .RS 16n |
|
66 .rt |
|
67 There was invalid UTF-8, or an error was found. |
|
68 .RE |
|
69 |
|
70 .SH ATTRIBUTES |
|
71 .sp |
|
72 .LP |
|
73 See \fBattributes\fR(5) for descriptions of the following attributes: |
|
74 .sp |
|
75 |
|
76 .sp |
|
77 .TS |
|
78 tab() box; |
|
79 cw(2.75i) |cw(2.75i) |
|
80 lw(2.75i) |lw(2.75i) |
|
81 . |
|
82 ATTRIBUTE TYPEATTRIBUTE VALUE |
|
83 _ |
|
84 Availabilitysystem/library/security/libsasl |
|
85 _ |
|
86 Interface StabilityCommitted |
|
87 _ |
|
88 MT-LevelMT-Safe |
|
89 .TE |
|
90 |
|
91 .SH SEE ALSO |
|
92 .sp |
|
93 .LP |
|
94 \fBattributes\fR(5) |