Core Function SubStr

From Sputnik Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "<pre> SubStr( <expression>, <start>, <end> ) </pre> === Description === Return part of a string === Parameters === ==== expression ==== The expression to evaluate. ==== sta...")
 
(start)
Line 16: Line 16:
  
 
The character position to start. (0 = first character)
 
The character position to start. (0 = first character)
 +
 +
OR
 +
 +
If the start is a negative value the character position will work backwards from the length of the string.
  
 
==== count ====
 
==== count ====

Revision as of 17:00, 17 August 2013

SubStr( <expression>, <start>, <end> )

Contents

Description

Return part of a string

Parameters

expression

The expression to evaluate.

start

The character position to start. (0 = first character)

OR

If the start is a negative value the character position will work backwards from the length of the string.

count

Optional; The number of characters to extract. By default the entire remainder of the string.

Return Value

Success: Returns the extracted string.

Failure: Returns an empty string.

Remarks

None.

Example

$var = Substr("I am a string", 2, 2);
MsgBox("2 chars extracted from position 2 are: $var");
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox