.\" This man page is automatically generated using
.\" kayadoc2man from the Kaya development tools and the -xmldocs compile 
.\" option. Editing it directly is not encouraged.
.\" It is under the same license as the source .k file that it was
.\" generated from.
.TH "Binary.readBlock" "3kaya" "August 2014" "Kaya" "Kaya module reference"
.SH "NAME"
Binary::readBlock \- Read a block from a file.
.SH "SYNOPSIS"
.B Binary readBlock(
\fIFile h, Int bsize\fP
.B ")"
.SH "ARGUMENTS"
.PP
.B "h"
A file handle to read from
.PP
.B "bsize"
The maximum number of bytes to read
.SH "DESCRIPTION"
.PP
Creates a block of size
\fIbsize\fP
and reads data into it.
If there is less data to read than
\fIbsize\fP
, the block will contain as much data as could be read, and the
.B "Binary.blockSize"(3kaya)
function will return the size of the data that was read. Naturally, the file handle must be valid and readable.
.SH "AUTHORS"
Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/
.SH LICENSE
The Kaya standard library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (version 2.1 or any later version) as published by the Free Software Foundation.
.SH "RELATED"
.PD 0
.PP
.B "Binary.Binary"(3kaya)
.PP
.BR "IO(3kaya)"
.PP
.B "Binary.writeBlock"(3kaya)
.PD 0.4v