Commit 6be630b9 authored by Benjamin Kaduk's avatar Benjamin Kaduk Committed by Rich Salz
Browse files

Clarify the behavior of BIO_gets() a bit more 



The API contract is more tight than was previously documented -- the returned
string must be NUL-terminated, and the supplied buffer includes space for
the trailing NUL, so the maximum length that can be read in is reduced.

Clarify that the NUL is not included in the returned length, and fix the
spelling of "NUL-terminated" in a nearby spot.

Adjust punctuation to make a modest improvement to the grammar.

Reviewed-by: default avatarMatt Caswell <matt@openssl.org>
Reviewed-by: default avatarRich Salz <rsalz@openssl.org>
parent b6ca88ab

doc/crypto/BIO_read.pod

+6 −4
Original line number Diff line number Diff line
@@ -20,20 +20,22 @@ the data in B<buf>. 


BIO_gets() performs the BIOs "gets" operation and places the data

in B<buf>. Usually this operation will attempt to read a line of data

from the BIO of maximum length B<len>. There are exceptions to this

however, for example BIO_gets() on a digest BIO will calculate and

from the BIO of maximum length B<len-1>. There are exceptions to this,

however; for example, BIO_gets() on a digest BIO will calculate and

return the digest and other BIOs may not support BIO_gets() at all.

The returned string is always NUL-terminated.



BIO_write() attempts to write B<len> bytes from B<buf> to BIO B<b>.



BIO_puts() attempts to write a null terminated string B<buf> to BIO B<b>.

BIO_puts() attempts to write a NUL-terminated string B<buf> to BIO B<b>.



=head1 RETURN VALUES



All these functions return either the amount of data successfully read or

written (if the return value is positive) or that no data was successfully

read or written if the result is 0 or -1. If the return value is -2 then

the operation is not implemented in the specific BIO type.

the operation is not implemented in the specific BIO type.  The trailing

NUL is not included in the length returned by BIO_gets().



=head1 NOTES