opensolaris man page for sasl_encode64

sasl_encode64(3SASL)			      Simple Authentication Security Layer Library Functions			      sasl_encode64(3SASL)

NAME
       sasl_encode64 - encode base64 string

SYNOPSIS
       cc [ flag ... ] file ... -lsasl	 [ library ... ]
       #include <sasl/saslutil.h>

       int sasl_encode64(const char *in, unsigned inlen, char *out,
	    unsigned outmax, unsigned *outlen);

DESCRIPTION
       Use  the  sasl_encode64()  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 outlen is non-NULL, the length is placed in
       the outlen.

PARAMETERS
       in	 Input data.

       inlen	 The length of the input data.

       out	 The output data. The value of out can be the same as in. However, there must be enough space.

       outlen	 The length of the actual output.

       outmax	 The maximum size of the output buffer.

RETURN VALUES
       sasl_encode64() returns an integer that corresponds to a SASL error code.

ERRORS
       SASL_OK	       The call to sasl_encode64() was successful.

       SASL_BUFOVER    The output buffer was too small.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWlibsasl		   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       sasl_errors(3SASL), attributes(5)

SunOS 5.11							    16 Sep 2003 					      sasl_encode64(3SASL)