WoW:API strbyte

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW Lua

← WoW Lua

Returns the numerical code of a character in a string.

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

Arguments

s [, index[, endIndex]]

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

endIndex

Number - Optional argument specifying the index of the last character to return the 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
> = string.byte("ABCDE", 1, 3)
65           66           67

Details

The first valid index is 1.

The last valid index is the length of the string.