components/cyrus-sasl/Solaris/usr/share/man/man3/sasl_utf8verify.3
author saurabh.vyas@oracle.com
Wed, 27 Jan 2016 09:13:52 -0800
changeset 5350 0bd2e97a57c6
parent 5055 9daf220c1a9a
child 5769 6303cfed086b
permissions -rw-r--r--
22599480 move mcollective to Ruby 2.1 22599526 move stomp to Ruby 2.1

'\" te
.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
.\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
.TH sasl_utf8verify 3SASL "1 Oct 2003" "SunOS 5.12" "Simple Authentication Security Layer Library Functions"
.SH NAME
sasl_utf8verify \- encode base64 string
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
#include <sasl/saslutil.h>

\fBint\fR \fBsasl_utf8verify\fR(\fBconst char *\fR\fIstr\fR, \fBunsigned\fR \fIlen\fR);
.fi

.SH DESCRIPTION
.sp
.LP
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.
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIstr\fR\fR
.ad
.RS 7n
.rt  
A string
.RE

.sp
.ne 2
.mk
.na
\fB\fIlen\fR\fR
.ad
.RS 7n
.rt  
The length of the string
.RE

.SH RETURN VALUES
.sp
.LP
\fBsasl_utf8verify()\fR returns an integer that corresponds to a SASL error code.
.SH ERRORS
.sp
.ne 2
.mk
.na
\fB\fBSASL_OK\fR\fR
.ad
.RS 16n
.rt  
The call to \fBsasl_utf8verify()\fR was successful.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSASL_BADPROT\fR\fR
.ad
.RS 16n
.rt  
There was invalid UTF-8, or an error was found.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Availabilitysystem/library/security/libsasl
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBattributes\fR(5)