X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=blobdiff_plain;f=doc%2Fcrypto%2FBIO_ctrl.pod;h=acc46db8ce74044542ee17880cf83b074124c15e;hp=aed2095925f1c644f52495235e6de19e640c90e3;hb=93fe6e13a379c5902dddb49f3d331e795d049a43;hpb=32751b8ab10cd5cedd47ed7768e20bc14471da7a diff --git a/doc/crypto/BIO_ctrl.pod b/doc/crypto/BIO_ctrl.pod index aed2095925..acc46db8ce 100644 --- a/doc/crypto/BIO_ctrl.pod +++ b/doc/crypto/BIO_ctrl.pod @@ -3,9 +3,9 @@ =head1 NAME BIO_ctrl, BIO_callback_ctrl, BIO_ptr_ctrl, BIO_int_ctrl, BIO_reset, -BIO_flush, BIO_eof, BIO_set_close, BIO_get_close, BIO_pending, -BIO_wpending, BIO_ctrl_pending, BIO_ctrl_wpending, BIO_get_info_callback, -BIO_set_info_callback - BIO control operations +BIO_seek, BIO_tell, BIO_flush, BIO_eof, BIO_set_close, BIO_get_close, +BIO_pending, BIO_wpending, BIO_ctrl_pending, BIO_ctrl_wpending, +BIO_get_info_callback, BIO_set_info_callback - BIO control operations =head1 SYNOPSIS @@ -17,6 +17,8 @@ BIO_set_info_callback - BIO control operations long BIO_int_ctrl(BIO *bp,int cmd,long larg,int iarg); int BIO_reset(BIO *b); + int BIO_seek(BIO *b, int ofs); + int BIO_tell(BIO *b); int BIO_flush(BIO *b); int BIO_eof(BIO *b); int BIO_set_close(BIO *b,long flag); @@ -41,8 +43,14 @@ specific to a particular type of BIO are described in the specific BIOs manual page as well as any special features of the standard calls. -BIO_reset() typically reset a BIO to some initial state, in the case -of file related BIOs for example it rewinds the file pointer. +BIO_reset() typically resets a BIO to some initial state, in the case +of file related BIOs for example it rewinds the file pointer to the +start of the file. + +BIO_seek() resets a file related BIO's file position pointer to B +bytes from start of file. + +BIO_tell() returns the current file position of a file related BIO. BIO_flush() normally writes out any internally buffered data, in some cases it is used to signal EOF and that no more data will be written. @@ -58,14 +66,17 @@ be closed when the BIO is freed. BIO_get_close() returns the BIOs close flag. BIO_pending(), BIO_ctrl_pending(), BIO_wpending() and BIO_ctrl_wpending() -return the number of pending characterers in the BIOs read and write buffers. +return the number of pending characters in the BIOs read and write buffers. Not all BIOs support these calls. BIO_ctrl_pending() and BIO_ctrl_wpending() return a size_t type and are functions, BIO_pending() and BIO_wpending() are macros which call BIO_ctrl(). =head1 RETURN VALUES -BIO_reset() returns 1 fo success and 0 for failure. +BIO_reset() returns 1 for success and 0 for failure. + +BIO_seek() and BIO_tell() both return the current file position on success +and -1 for failure. BIO_flush() returns 1 for success and 0 or -1 for failure. @@ -97,7 +108,7 @@ This often means there is no need to locate the required BIO for a particular operation, it can be called on a chain and it will be automatically passed to the relevant BIO. -Source/sink BIOs will return an error if the do not recognise the +Source/sink BIOs will return an error if the do not recognize the BIO_ctrl() operation. =head1 SEE ALSO