doc/manpages/gnutls_srp_base64_encode_alloc.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_srp_base64_encode_alloc" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_srp_base64_encode_alloc \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_srp_base64_encode_alloc(const gnutls_datum_t * " data ", gnutls_datum_t * " result ");"
   9 .SH ARGUMENTS
  10 .IP "const gnutls_datum_t * data" 12
  11 contains the raw data
  12 .IP "gnutls_datum_t * result" 12
  13 will hold the newly allocated encoded data
  14 .SH "DESCRIPTION"
  15 This function will convert the given data to printable data, using
  16 the base64 encoding.  This is the encoding used in SRP password
  17 files.  This function will allocate the required memory to hold
  18 the encoded data.
  19
  20 You should use \fBgnutls_free()\fP to free the returned data.
  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 0 on success, or an error code.
  26 .SH "REPORTING BUGS"
  27 Report bugs to <bug-gnutls@gnu.org>.
  28 GnuTLS home page: http://www.gnu.org/software/gnutls/
  29 General help using GNU software: http://www.gnu.org/gethelp/
  30 .SH COPYRIGHT
  31 Copyright \(co 2008 Free Software Foundation.
  32 .br
  33 Copying and distribution of this file, with or without modification,
  34 are permitted in any medium without royalty provided the copyright
  35 notice and this notice are preserved.
  36 .SH "SEE ALSO"
  37 The full documentation for
  38 .B gnutls
  39 is maintained as a Texinfo manual.  If the
  40 .B info
  41 and
  42 .B gnutls
  43 programs are properly installed at your site, the command
  44 .IP
  45 .B info gnutls
  46 .PP
  47 should give you access to the complete manual.