Blame doc/manpages/gnutls_session_supplemental_register.3

Packit 549fdc
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit 549fdc
.TH "gnutls_session_supplemental_register" 3 "3.6.2" "gnutls" "gnutls"
Packit 549fdc
.SH NAME
Packit 549fdc
gnutls_session_supplemental_register \- API function
Packit 549fdc
.SH SYNOPSIS
Packit 549fdc
.B #include <gnutls/gnutls.h>
Packit 549fdc
.sp
Packit 549fdc
.BI "int gnutls_session_supplemental_register(gnutls_session_t " session ", const char * " name ", gnutls_supplemental_data_format_type_t " type ", gnutls_supp_recv_func " recv_func ", gnutls_supp_send_func " send_func ", unsigned " flags ");"
Packit 549fdc
.SH ARGUMENTS
Packit 549fdc
.IP "gnutls_session_t session" 12
Packit 549fdc
the session for which this will be registered
Packit 549fdc
.IP "const char * name" 12
Packit 549fdc
the name of the supplemental data to register
Packit 549fdc
.IP "gnutls_supplemental_data_format_type_t type" 12
Packit 549fdc
the type of the supplemental data format
Packit 549fdc
.IP "gnutls_supp_recv_func recv_func" 12
Packit 549fdc
the function to receive the data
Packit 549fdc
.IP "gnutls_supp_send_func send_func" 12
Packit 549fdc
the function to send the data
Packit 549fdc
.IP "unsigned flags" 12
Packit 549fdc
must be zero
Packit 549fdc
.SH "DESCRIPTION"
Packit 549fdc
This function will register a new supplemental data type (rfc4680).
Packit 549fdc
The registered supplemental functions will be used for that specific
Packit 549fdc
session. The provided  \fItype\fP must be an unassigned type in
Packit 549fdc
\fBgnutls_supplemental_data_format_type_t\fP.
Packit 549fdc
Packit 549fdc
If the type is already registered or handled by GnuTLS internally
Packit 549fdc
\fBGNUTLS_E_ALREADY_REGISTERED\fP will be returned.
Packit 549fdc
.SH "RETURNS"
Packit 549fdc
\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code.
Packit 549fdc
.SH "SINCE"
Packit 549fdc
3.5.5
Packit 549fdc
.SH "REPORTING BUGS"
Packit 549fdc
Report bugs to <bugs@gnutls.org>.
Packit 549fdc
.br
Packit 549fdc
Home page: http://www.gnutls.org
Packit 549fdc
Packit 549fdc
.SH COPYRIGHT
Packit 549fdc
Copyright \(co 2001-2018 Free Software Foundation, Inc., and others.
Packit 549fdc
.br
Packit 549fdc
Copying and distribution of this file, with or without modification,
Packit 549fdc
are permitted in any medium without royalty provided the copyright
Packit 549fdc
notice and this notice are preserved.
Packit 549fdc
.SH "SEE ALSO"
Packit 549fdc
The full documentation for
Packit 549fdc
.B gnutls
Packit 549fdc
is maintained as a Texinfo manual.
Packit 549fdc
If the /usr/share/doc/gnutls/
Packit 549fdc
directory does not contain the HTML form visit
Packit 549fdc
.B
Packit 549fdc
.IP http://www.gnutls.org/manual/
Packit 549fdc
.PP