Editing Substring - StringUtil

[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:SKSE]]
'''SKSE Member of:''' [[StringUtil Script]]

Returns a portion of the string starting at given index, optionally with specified amount of characters. (This function requires SKSE)

== Syntax ==
<syntaxhighlight lang="papyrus">
string Function Substring(string s, int startIndex, int len = 0) global native
</syntaxhighlight>

== Parameters ==
*s: The string from which to retrieve the substring.
*startIndex: Starting character position of a substring.
*len: An optional length of the substring. Default of 0 means for the entire string.
**'''Default''': 0

== Return Value ==
Portion from the given string.
Returns none if the given startIndex was invalid.

== Examples ==
<syntaxhighlight lang="papyrus">
Import StringUtil

string ss = "Sample string"
string s1 = Substring(ss, 5) 
;"e string"
string s2 = Substring(ss, 2, 4) 
;"mple"
string s3 = Substring(ss, 20) 
;none
string s4 = Substring(ss, 0, -1) 
;"sample string"
</syntaxhighlight>

== Notes ==
Invalid len value will work as if 0 was given.<br/>
This function is case-insensitive (like all SKSE string functions right now).

== See Also ==
*[[StringUtil Script]]
*[[Find - StringUtil]]