byteOffset

Type

function

Summary

Returns the byte position of the first occourence of the specified string of binary data within container of binary data.

Syntax

byteOffset(<bytesToFind>,<binaryStringToSearch> [,<bytesToSkip>])

Description

Use the byteOffset function to find where a string of binary data occurs within a container of binary data.

The value returned by the byteOffset function is the number of the bytes where bytesToFind appears in binaryStringToSearch. If the bytessToFind is not in binaryStringToSearch, the byteOffset function returns zero.

If the bytesToFind contains more than one byte, and the entire bytesToFind appears in the bytesToSearch, the byteOffset function returns the byte number where the bytesToFind starts.

If you specify how many bytesToSkip, the byteOffset function skips the specified number of bytes in the binaryStringToSearch. The value returned is relative to this starting point instead of the beginning of the binaryStringToSearch.

Parameters

Name	Type	Description
bytesToFind	data	a string of binary data to find
binaryStringToSearch	data	a container with binary data
bytesToSkip		A non-negative integer. If you don't specify how many bytesToSkip, the byteOffset function does not skip any bytes and starts at the beginning of the binaryStringToSearch.

Examples

byteOffset("c","abcde") -- returns 3

byteOffset("b","abacadabra",2) -- returns 6

byteOffset("bark","embarking") -- returns 3

byteOffset(null & numberToByte(255),"End" & null & numberToByte(255)) -- returns 4

Value

Name	Type	Description
return		The byteOffset function returns a non-negative integer.

Related

keyword: character, characters, integer, string, point

operator: begins with

command: find, sort container

control structure: function

function: offset, wordOffset, itemOffset, lineOffset, length, value

glossary: binary data, return, non-negative

Compatibility and Support

Introduced

LiveCode 7.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile