doc/manpages/gnutls_psk_set_client_credentials.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_psk_set_client_credentials" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_psk_set_client_credentials \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_psk_set_client_credentials(gnutls_psk_client_credentials_t " res ", const char * " username ", const gnutls_datum_t * " key ", gnutls_psk_key_flags " flags ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_psk_client_credentials_t res" 12
  11 is a \fBgnutls_psk_client_credentials_t\fP structure.
  12 .IP "const char * username" 12
  13 is the user's zero\-terminated userid
  14 .IP "const gnutls_datum_t * key" 12
  15 is the user's key
  16 .IP "gnutls_psk_key_flags flags" 12
  17 .SH "DESCRIPTION"
  18 This function sets the username and password, in a
  19 gnutls_psk_client_credentials_t structure.  Those will be used in
  20 PSK authentication.  \fIusername\fP should be an ASCII string or UTF\-8
  21 strings prepared using the "SASLprep" profile of "stringprep".  The
  22 key can be either in raw byte format or in Hex format (without the
  23 0x prefix).
  24 .SH "RETURNS"
  25 \fBGNUTLS_E_SUCCESS\fP 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.