1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v
7.if n .sp
8..
9.de Vb \" Begin verbatim text
10.ft CW
11.nf
12.ne \\$1
13..
14.de Ve \" End verbatim text
15.ft R
16.fi
17..
18.\" Set up some character translations and predefined strings. \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20.\" double quote, and \*(R" will give a right double quote. \*(C+ will
21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23.\" nothing in troff, for use with C<>.
24.tr \(*W-
25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26.ie n \{\
27. ds -- \(*W-
28. ds PI pi
29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31. ds L" ""
32. ds R" ""
33. ds C` ""
34. ds C' ""
35'br\}
36.el\{\
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
41'br\}
42.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
47.\" If the F register is turned on, we'll generate index entries on stderr for
48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
51.ie \nF \{\
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
54..
55. nr % 0
56. rr F
57.\}
58.el \{\
59. de IX
60..
61.\}
62.\"
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff
66.if n \{\
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
--- 48 unchanged lines hidden (view full) ---
119. ds Th \o'LP'
120. ds ae ae
121. ds Ae AE
122.\}
123.rm #[ #] #H #V #F C
124.\" ========================================================================
125.\"
126.IX Title "BIO_ctrl 3"
127.TH BIO_ctrl 3 "2010-11-16" "0.9.8p" "OpenSSL"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
132.SH "NAME"
133BIO_ctrl, BIO_callback_ctrl, BIO_ptr_ctrl, BIO_int_ctrl, BIO_reset,
134BIO_seek, BIO_tell, BIO_flush, BIO_eof, BIO_set_close, BIO_get_close,
135BIO_pending, BIO_wpending, BIO_ctrl_pending, BIO_ctrl_wpending,
136BIO_get_info_callback, BIO_set_info_callback \- BIO control operations
137.SH "SYNOPSIS"
138.IX Header "SYNOPSIS"
139.Vb 1
140\& #include <openssl/bio.h>
141\&
142\& long BIO_ctrl(BIO *bp,int cmd,long larg,void *parg);
143\& long BIO_callback_ctrl(BIO *b, int cmd, void (*fp)(struct bio_st *, int, const char *, int, long, long));
144\& char * BIO_ptr_ctrl(BIO *bp,int cmd,long larg);
145\& long BIO_int_ctrl(BIO *bp,int cmd,long larg,int iarg);
146\&
147\& int BIO_reset(BIO *b);
148\& int BIO_seek(BIO *b, int ofs);
149\& int BIO_tell(BIO *b);
150\& int BIO_flush(BIO *b);
151\& int BIO_eof(BIO *b);
152\& int BIO_set_close(BIO *b,long flag);
153\& int BIO_get_close(BIO *b);
154\& int BIO_pending(BIO *b);
155\& int BIO_wpending(BIO *b);
156\& size_t BIO_ctrl_pending(BIO *b);
157\& size_t BIO_ctrl_wpending(BIO *b);
158\&
159\& int BIO_get_info_callback(BIO *b,bio_info_cb **cbp);
160\& int BIO_set_info_callback(BIO *b,bio_info_cb *cb);
161\&
162\& typedef void bio_info_cb(BIO *b, int oper, const char *ptr, int arg1, long arg2, long arg3);
163.Ve
164.SH "DESCRIPTION"
165.IX Header "DESCRIPTION"
166\&\fIBIO_ctrl()\fR, \fIBIO_callback_ctrl()\fR, \fIBIO_ptr_ctrl()\fR and \fIBIO_int_ctrl()\fR
167are \s-1BIO\s0 \*(L"control\*(R" operations taking arguments of various types.
168These functions are not normally called directly, various macros
169are used instead. The standard macros are described below, macros
--- 71 unchanged lines hidden (view full) ---
241.PP
242Source/sink BIOs return an 0 if they do not recognize the \fIBIO_ctrl()\fR
243operation.
244.SH "BUGS"
245.IX Header "BUGS"
246Some of the return values are ambiguous and care should be taken. In
247particular a return value of 0 can be returned if an operation is not
248supported, if an error occurred, if \s-1EOF\s0 has not been reached and in
249the case of \fIBIO_seek()\fR on a file \s-1BIO\s0 for a successful operation.
250.SH "SEE ALSO"
251.IX Header "SEE ALSO"
252\&\s-1TBA\s0
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v
7.if n .sp
8..
9.de Vb \" Begin verbatim text
10.ft CW
11.nf
12.ne \\$1
13..
14.de Ve \" End verbatim text
15.ft R
16.fi
17..
18.\" Set up some character translations and predefined strings. \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20.\" double quote, and \*(R" will give a right double quote. \*(C+ will
21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23.\" nothing in troff, for use with C<>.
24.tr \(*W-
25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26.ie n \{\
27. ds -- \(*W-
28. ds PI pi
29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31. ds L" ""
32. ds R" ""
33. ds C` ""
34. ds C' ""
35'br\}
36.el\{\
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
41'br\}
42.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
47.\" If the F register is turned on, we'll generate index entries on stderr for
48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
51.ie \nF \{\
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
54..
55. nr % 0
56. rr F
57.\}
58.el \{\
59. de IX
60..
61.\}
62.\"
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff
66.if n \{\
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
--- 48 unchanged lines hidden (view full) ---
119. ds Th \o'LP'
120. ds ae ae
121. ds Ae AE
122.\}
123.rm #[ #] #H #V #F C
124.\" ========================================================================
125.\"
126.IX Title "BIO_ctrl 3"
127.TH BIO_ctrl 3 "2010-11-16" "0.9.8p" "OpenSSL"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
132.SH "NAME"
133BIO_ctrl, BIO_callback_ctrl, BIO_ptr_ctrl, BIO_int_ctrl, BIO_reset,
134BIO_seek, BIO_tell, BIO_flush, BIO_eof, BIO_set_close, BIO_get_close,
135BIO_pending, BIO_wpending, BIO_ctrl_pending, BIO_ctrl_wpending,
136BIO_get_info_callback, BIO_set_info_callback \- BIO control operations
137.SH "SYNOPSIS"
138.IX Header "SYNOPSIS"
139.Vb 1
140\& #include <openssl/bio.h>
141\&
142\& long BIO_ctrl(BIO *bp,int cmd,long larg,void *parg);
143\& long BIO_callback_ctrl(BIO *b, int cmd, void (*fp)(struct bio_st *, int, const char *, int, long, long));
144\& char * BIO_ptr_ctrl(BIO *bp,int cmd,long larg);
145\& long BIO_int_ctrl(BIO *bp,int cmd,long larg,int iarg);
146\&
147\& int BIO_reset(BIO *b);
148\& int BIO_seek(BIO *b, int ofs);
149\& int BIO_tell(BIO *b);
150\& int BIO_flush(BIO *b);
151\& int BIO_eof(BIO *b);
152\& int BIO_set_close(BIO *b,long flag);
153\& int BIO_get_close(BIO *b);
154\& int BIO_pending(BIO *b);
155\& int BIO_wpending(BIO *b);
156\& size_t BIO_ctrl_pending(BIO *b);
157\& size_t BIO_ctrl_wpending(BIO *b);
158\&
159\& int BIO_get_info_callback(BIO *b,bio_info_cb **cbp);
160\& int BIO_set_info_callback(BIO *b,bio_info_cb *cb);
161\&
162\& typedef void bio_info_cb(BIO *b, int oper, const char *ptr, int arg1, long arg2, long arg3);
163.Ve
164.SH "DESCRIPTION"
165.IX Header "DESCRIPTION"
166\&\fIBIO_ctrl()\fR, \fIBIO_callback_ctrl()\fR, \fIBIO_ptr_ctrl()\fR and \fIBIO_int_ctrl()\fR
167are \s-1BIO\s0 \*(L"control\*(R" operations taking arguments of various types.
168These functions are not normally called directly, various macros
169are used instead. The standard macros are described below, macros
--- 71 unchanged lines hidden (view full) ---
241.PP
242Source/sink BIOs return an 0 if they do not recognize the \fIBIO_ctrl()\fR
243operation.
244.SH "BUGS"
245.IX Header "BUGS"
246Some of the return values are ambiguous and care should be taken. In
247particular a return value of 0 can be returned if an operation is not
248supported, if an error occurred, if \s-1EOF\s0 has not been reached and in
249the case of \fIBIO_seek()\fR on a file \s-1BIO\s0 for a successful operation.
250.SH "SEE ALSO"
251.IX Header "SEE ALSO"
252\&\s-1TBA\s0