WoW:API strbyte

From AddOn Studio
Revision as of 14:03, 27 June 2007 by WoWWiki>Ravas (Updated to match the API boilerplate.)
Jump to navigation Jump to search

Lua/Libshortcut

Returns the numerical code of a character in a string.

indexByte = string.byte(s [, index])


Arguments

s [, index]
s
String - The string to get the numerical code from
index
Number - Optional argument specifying the index of the character to get the byte value of


Returns

indexByte
Number - The byte value of the character at the specified position or nil if the index is invalid


Example

> = string.byte("ABCDE")      -- no index, so the first character
65
> = string.byte("ABCDE",1)    -- indexes start at 1
65
> = string.byte("ABCDE",0)    -- we're not using C
> = string.byte("ABCDE",100)  -- index out of range, no value returned


Details

The first valid index is 1.
The last valid index is the length of the string.

Template:LUA