.\" 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.peekString" "3kaya" "August 2014" "Kaya" "Kaya module reference"
.SH "NAME"
Binary::peekString \- Read a String from binary data.
.SH "SYNOPSIS"
.B String peekString(
\fIBinary block, Int offset\fP
.B ")"
.SH "ARGUMENTS"
.PP
.B "block"
The binary block
.PP
.B "offset"
The location to read from (starting from zero)
.SH "DESCRIPTION"
.PP
Peek at the string
\fIval\fP
starting at offset
\fIoffset\fP
 An
.B "Binary.OffsetOutOfRange"(3kaya)
exception will be thrown if it attempts to access a value outside the block. Note that Kaya assumes the String is stored in the block in UTF-8 encoding, with null-termination.
.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
.B "Binary.array"(3kaya)
.PP
.B "Binary.getBlockChunk"(3kaya)
.PP
.B "Binary.peek"(3kaya)
.PP
.B "Binary.pokeString"(3kaya)
.PD 0.4v