Difference between revisions of "String.byte"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[string]]<br/>
 +
 
=== Description ===
 
=== Description ===
<translate>Returns the internal numerical codes of the characters s[i], s[i+1], ···, s[j]. The default value for i is 1; the default value for j is i.  
+
Returns the internal numerical codes of the characters s[i], s[i+1], ···, s[j].
 +
<syntaxhighlight lang="lua">
 +
(numbers) = string.byte(s,i,j)
 +
</syntaxhighlight>
 +
 
 +
The default value for i is 1; the default value for j is i.
 +
 
 +
Returns nil if index out of range.
 +
 
 +
'''Numerical codes are not necessarily portable across platforms.'''
  
Note that numerical codes are not necessarily portable across platforms.</translate>
 
<source lang="lua">
 
(numbers) = string.byte(s,i,j)
 
</source>
 
 
=== Parameters ===
 
=== Parameters ===
'''s''': (string) <translate>string to get numerical codes from</translate> <br/>
+
'''s''': (string) string to get numerical codes from<br/>
'''i''': (number) <translate>start symbol (default = 1)</translate> '''optional'''<br/>
+
'''i''': (number) start symbol (default = 1) '''optional'''<br/>
'''j''': (number) <translate>end symbol (defaults = i)</translate> '''optional'''<br/>
+
'''j''': (number) end symbol (defaults = i) '''optional'''<br/>
 +
 
 
=== Return values ===
 
=== Return values ===
'''Returns''' (numbers) <translate>numerical codes of characters in provided range</translate><br/>
+
'''Returns''' (numbers) numerical codes of characters in provided range or nil<br/>
 +
 
 +
{{String}}

Latest revision as of 15:33, 13 July 2023

Available since: Gideros 2011.6
Class: string

Description

Returns the internal numerical codes of the characters s[i], s[i+1], ···, s[j].

(numbers) = string.byte(s,i,j)

The default value for i is 1; the default value for j is i.

Returns nil if index out of range.

Numerical codes are not necessarily portable across platforms.

Parameters

s: (string) string to get numerical codes from
i: (number) start symbol (default = 1) optional
j: (number) end symbol (defaults = i) optional

Return values

Returns (numbers) numerical codes of characters in provided range or nil