share/man/man3sasl/sasl_utf8verify.3sasl

   1 '\" te
   2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems,
   4 .\" Inc. All Rights Reserved
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH SASL_UTF8VERIFY 3SASL "Oct 1, 2003"
   9 .SH NAME
  10 sasl_utf8verify \- encode base64 string
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/saslutil.h>
  16
  17 \fBint\fR \fBsasl_utf8verify\fR(\fBconst char *\fR\fIstr\fR, \fBunsigned\fR \fIlen\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 Use the \fBsasl_utf8verify()\fR interface to verify that a string is valid
  24 UTF-8 and does not contain \fINULL\fR, a carriage return, or a linefeed. If
  25 \fIlen\fR ==0, \fBstrlen\fR(\fIstr\fR) will be used.
  26 .SH PARAMETERS
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIstr\fR\fR
  31 .ad
  32 .RS 7n
  33 A string
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIlen\fR\fR
  40 .ad
  41 .RS 7n
  42 The length of the string
  43 .RE
  44
  45 .SH RETURN VALUES
  46 .sp
  47 .LP
  48 \fBsasl_utf8verify()\fR returns an integer that corresponds to a SASL error
  49 code.
  50 .SH ERRORS
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBSASL_OK\fR\fR
  55 .ad
  56 .RS 16n
  57 The call to \fBsasl_utf8verify()\fR was successful.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBSASL_BADPROT\fR\fR
  64 .ad
  65 .RS 16n
  66 There was invalid UTF-8, or an error was found.
  67 .RE
  68
  69 .SH ATTRIBUTES
  70 .sp
  71 .LP
  72 See \fBattributes\fR(5) for descriptions of the following attributes:
  73 .sp
  74
  75 .sp
  76 .TS
  77 box;
  78 c | c
  79 l | l .
  80 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  81 _
  82 Interface Stability     Evolving
  83 _
  84 MT-Level        MT-Safe
  85 .TE
  86
  87 .SH SEE ALSO
  88 .sp
  89 .LP
  90 \fBattributes\fR(5)