Scroll to navigation

Binary.pokeString(3kaya) Kaya module reference Binary.pokeString(3kaya)

NAME

Binary::pokeString - Write a String of binary data.

SYNOPSIS

Void pokeString( var Binary block, Int offset, String val )

ARGUMENTS

block The binary block
offset The location to write to (starting from zero)
val The String to write.

DESCRIPTION

Poke the string val into the block, starting at offset offset
An Binary.OffsetOutOfRange (3kaya) exception will be thrown if it attempts to access a value outside the block. Note that the String will be stored in the block in UTF-8 encoding, not as raw Kaya chars, so you need to use Builtins.byteLength (3kaya) to determine how much space you need (and then add one for a terminating null byte).

AUTHORS

Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/

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.

RELATED

Binary.Binary (3kaya)
Builtins.byteLength (3kaya)
Binary.peekString (3kaya)
Binary.poke (3kaya)
Binary.setBlockData (3kaya)
August 2014 Kaya