Add a number of documentation files, mostly for SSL routines, but also
[openssl.git] / doc / crypto / BIO_ctrl_pending.pod
1 =pod
2
3 =head1 NAME
4
5 BIO_ctrl_pending - Find out how much bytes are buffered in a BIO
6
7 =head1 SYNOPSIS
8
9  #include <openssl/bio.h>
10
11  size_t BIO_ctrl_pending(BIO *bio);
12
13 =head1 DESCRIPTION
14
15 BIO_ctrl_pending() returns the number of bytes buffered in a BIO.
16
17 =head1 BUGS
18
19 When B<bio> is NULL, the OpenSSL library calls assert().
20
21 =head1 RETURN VALUES
22
23 The following return values can occur:
24
25 =over 4
26
27 =item E<gt>=0
28
29 The number of bytes pending the BIO.
30
31 =back
32
33 =head1 SEE ALSO
34
35 L<bio(3)|bio(3)>, L<BIO_s_mem(3)|BIO_s_mem(3)>,
36 L<BIO_new_bio_pair(3)|BIO_new_bio_pair(3)>