doc/manpages/gnutls_srp_base64_encode.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_srp_base64_encode" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_srp_base64_encode \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_srp_base64_encode(const gnutls_datum_t * " data ", char * " result ", size_t * " result_size ");"
   9 .SH ARGUMENTS
  10 .IP "const gnutls_datum_t * data" 12
  11 contain the raw data
  12 .IP "char * result" 12
  13 the place where base64 data will be copied
  14 .IP "size_t * result_size" 12
  15 holds the size of the result
  16 .SH "DESCRIPTION"
  17 This function will convert the given data to printable data, using
  18 the base64 encoding, as used in the libsrp.  This is the encoding
  19 used in SRP password files.  If the provided buffer is not long
  20 enough GNUTLS_E_SHORT_MEMORY_BUFFER is returned.
  21
  22 Warning!  This base64 encoding is not the "standard" encoding, so
  23 do not use it for non\-SRP purposes.
  24 .SH "RETURNS"
  25 \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the buffer given is not
  26 long enough, or 0 on success.
  27 .SH "REPORTING BUGS"
  28 Report bugs to <bug-gnutls@gnu.org>.
  29 GnuTLS home page: http://www.gnu.org/software/gnutls/
  30 General help using GNU software: http://www.gnu.org/gethelp/
  31 .SH COPYRIGHT
  32 Copyright \(co 2008 Free Software Foundation.
  33 .br
  34 Copying and distribution of this file, with or without modification,
  35 are permitted in any medium without royalty provided the copyright
  36 notice and this notice are preserved.
  37 .SH "SEE ALSO"
  38 The full documentation for
  39 .B gnutls
  40 is maintained as a Texinfo manual.  If the
  41 .B info
  42 and
  43 .B gnutls
  44 programs are properly installed at your site, the command
  45 .IP
  46 .B info gnutls
  47 .PP
  48 should give you access to the complete manual.