Doc de {output,input}_binary_int (PR#2019)

git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@6235 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
master
Xavier Leroy 2004-04-18 08:33:03 +00:00
parent 7a53dbb6f0
commit 884bd4d7e5
1 changed files with 5 additions and 3 deletions

View File

@ -603,7 +603,9 @@ val output_byte : out_channel -> int -> unit
256. *)
val output_binary_int : out_channel -> int -> unit
(** Write one integer in binary format on the given output channel.
(** Write one integer in binary format (4 bytes, big-endian)
on the given output channel.
The given integer is taken modulo 2{^32}.
The only reliable way to read it back is through the
{!Pervasives.input_binary_int} function. The format is compatible across
all machines for a given version of Objective Caml. *)
@ -713,8 +715,8 @@ val input_byte : in_channel -> int
Raise [End_of_file] if an end of file was reached. *)
val input_binary_int : in_channel -> int
(** Read an integer encoded in binary format from the given input
channel. See {!Pervasives.output_binary_int}.
(** Read an integer encoded in binary format (4 bytes, big-endian)
from the given input channel. See {!Pervasives.output_binary_int}.
Raise [End_of_file] if an end of file was reached while reading the
integer. *)