Current File : //usr/share/man/man3sasl/sasl_encode64.3sasl

'\" te
.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
.\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
.TH sasl_encode64 3SASL "16 Sep 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
.SH NAME
sasl_encode64 \- 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_encode64\fR(\fBconst char *\fR\fIin\fR, \fBunsigned\fR \fIinlen\fR, \fBchar *\fR\fIout\fR,
     \fBunsigned\fR \fIoutmax\fR, \fBunsigned *\fR\fIoutlen\fR);
.fi

.SH DESCRIPTION
.sp
.LP
Use the \fBsasl_encode64()\fR interface to convert an octet string into a base64 string. This routine is useful for SASL profiles that use base64, such as the IMAP (IMAP4) and POP (POP_AUTH) profiles. The output is null-terminated. If \fIoutlen\fR is non-\fINULL\fR, the length is placed in the \fIoutlen\fR.
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIin\fR\fR
.ad
.RS 10n
.rt  
Input data.
.RE

.sp
.ne 2
.mk
.na
\fB\fIinlen\fR\fR
.ad
.RS 10n
.rt  
The length of the input data.
.RE

.sp
.ne 2
.mk
.na
\fB\fIout\fR\fR
.ad
.RS 10n
.rt  
The output data. The value of \fIout\fR can be the same as \fIin\fR. However, there must be enough space.
.RE

.sp
.ne 2
.mk
.na
\fB\fIoutlen\fR\fR
.ad
.RS 10n
.rt  
The length of the actual output.
.RE

.sp
.ne 2
.mk
.na
\fB\fIoutmax\fR\fR
.ad
.RS 10n
.rt  
The maximum size of the output buffer.
.RE

.SH RETURN VALUES
.sp
.LP
\fBsasl_encode64()\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_encode64()\fR was successful.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSASL_BUFOVER\fR\fR
.ad
.RS 16n
.rt  
The output buffer was too small.
.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
\fBsasl_errors\fR(3SASL), \fBattributes\fR(5)