WoW:API strbyte: Difference between revisions
Jump to navigation
Jump to search
(Updated to match the API boilerplate.) |
({{luaapi}}) |
||
| Line 1: | Line 1: | ||
{{ | {{luaapi}} | ||
Returns the numerical code of a character in a string. | Returns the numerical code of a character in a string. | ||
indexByte = string.byte(s [, index]) | indexByte = string.byte(s [, index[, endIndex]]) | ||
indexByte = strbyte(s [, index[, endIndex]]) | |||
== Arguments == | == Arguments == | ||
:s [, index] | :s [, index[, endIndex]] | ||
:; s : String - The string to get the numerical code from | :; 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 | :; 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 == | == Returns == | ||
; indexByte : Number - The byte value of the character at the specified position or nil if the index is invalid | |||
== Example == | == Example == | ||
| Line 22: | Line 22: | ||
> = string.byte("ABCDE",0) -- we're not using C | > = string.byte("ABCDE",0) -- we're not using C | ||
> = string.byte("ABCDE",100) -- index out of range, no value returned | > = string.byte("ABCDE",100) -- index out of range, no value returned | ||
> = string.byte("ABCDE", 1, 3) | |||
65 66 67 | |||
== Details == | == Details == | ||
: The first valid index is 1. | : The first valid index is 1. | ||
: The last valid index is the length of the string. | : The last valid index is the length of the string. | ||
Revision as of 22:37, 25 March 2010
← 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.