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