add links to the new BIO and SSL manpages to make them visible on the web.
[openssl.git] / doc / crypto / BIO_ctrl_get_read_request.pod
1 =pod
2
3 =head1 NAME
4
5  BIO_ctrl_get_read_request - Find out how much bytes are were requested from the BIO
6
7 =head1 SYNOPSIS
8
9  #include <openssl/bio.h>
10
11  size_t BIO_ctrl_get_read_request(BIO *bio);
12
13 =head1 DESCRIPTION
14
15 BIO_ctrl_get_read_request() returns the number of bytes that were last
16 requested from B<bio> by a BIO_read() operation. This is useful e.g. for
17 BIO pairs, so that the application knows how much bytes to supply to B<bio>.
18
19 =head1 BUGS
20
21 When B<bio> is NULL, the OpenSSL library calls assert().
22
23 =head1 RETURN VALUES
24
25 The following return values can occur:
26
27 =over 4
28
29 =item E<gt>=0
30
31 The number of bytes requested.
32
33 =back
34
35 =head1 SEE ALSO
36
37 L<bio(3)|bio(3)>, L<BIO_s_mem(3)|BIO_s_mem(3)>,
38 L<BIO_new_bio_pair(3)|BIO_new_bio_pair(3)>