Blame doc/manpages/gnutls_range_split.3

Packit aea12f
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit Service 991b93
.TH "gnutls_range_split" 3 "3.6.14" "gnutls" "gnutls"
Packit aea12f
.SH NAME
Packit aea12f
gnutls_range_split \- API function
Packit aea12f
.SH SYNOPSIS
Packit aea12f
.B #include <gnutls/gnutls.h>
Packit aea12f
.sp
Packit aea12f
.BI "int gnutls_range_split(gnutls_session_t " session ", const gnutls_range_st * " orig ", gnutls_range_st * " next ", gnutls_range_st * " remainder ");"
Packit aea12f
.SH ARGUMENTS
Packit aea12f
.IP "gnutls_session_t session" 12
Packit aea12f
is a \fBgnutls_session_t\fP type
Packit aea12f
.IP "const gnutls_range_st * orig" 12
Packit aea12f
is the original range provided by the user
Packit aea12f
.IP "gnutls_range_st * next" 12
Packit aea12f
is the returned range that can be conveyed in a TLS record
Packit aea12f
.IP "gnutls_range_st * remainder" 12
Packit aea12f
is the returned remaining range
Packit aea12f
.SH "DESCRIPTION"
Packit aea12f
This function should be used when it is required to hide the length
Packit aea12f
of very long data that cannot be directly provided to \fBgnutls_record_send_range()\fP.
Packit aea12f
In that case this function should be called with the desired length
Packit aea12f
hiding range in  \fIorig\fP . The returned  \fInext\fP value should then be used in
Packit aea12f
the next call to \fBgnutls_record_send_range()\fP with the partial data.
Packit aea12f
That process should be repeated until  \fIremainder\fP is (0,0).
Packit aea12f
.SH "RETURNS"
Packit aea12f
0 in case splitting succeeds, non zero in case of error.
Packit aea12f
Note that  \fIorig\fP is not changed, while the values of  \fInext\fP and  \fIremainder\fP are modified to store the resulting values.
Packit aea12f
.SH "REPORTING BUGS"
Packit aea12f
Report bugs to <bugs@gnutls.org>.
Packit aea12f
.br
Packit aea12f
Home page: https://www.gnutls.org
Packit aea12f
Packit aea12f
.SH COPYRIGHT
Packit Service 991b93
Copyright \(co 2001- Free Software Foundation, Inc., and others.
Packit aea12f
.br
Packit aea12f
Copying and distribution of this file, with or without modification,
Packit aea12f
are permitted in any medium without royalty provided the copyright
Packit aea12f
notice and this notice are preserved.
Packit aea12f
.SH "SEE ALSO"
Packit aea12f
The full documentation for
Packit aea12f
.B gnutls
Packit aea12f
is maintained as a Texinfo manual.
Packit aea12f
If the /usr/share/doc/gnutls/
Packit aea12f
directory does not contain the HTML form visit
Packit aea12f
.B
Packit aea12f
.IP https://www.gnutls.org/manual/
Packit aea12f
.PP