Core Function StrIndex
From Sputnik Wiki
(Difference between revisions)
(→Example) |
|||
| Line 29: | Line 29: | ||
=== Return Value === | === Return Value === | ||
| − | Success: Returns the char the given index IF only 2 params are used. | + | Success: Returns the char at the given index IF only 2 params are used. |
| − | Success: Returns | + | |
| + | Success: Returns 1 IF 3 params are used. | ||
| + | |||
| + | Failure: Returns empty string IF only 2 params are used. | ||
| + | |||
| + | Failure: Returns 0 IF 3 params are used. | ||
| + | |||
| + | === Remarks === | ||
| + | |||
| + | When setting a char at a given Index it modifies the string in place and does not create a new one. | ||
=== Example === | === Example === | ||
| Line 43: | Line 52: | ||
StrIndex($a, 1, "C"); // Actually changes the char in the string | StrIndex($a, 1, "C"); // Actually changes the char in the string | ||
StrIndex($a, 2, "a"); // Actually changes the char in the string | StrIndex($a, 2, "a"); // Actually changes the char in the string | ||
| − | + | StrIndex($a, 3, "t"); // Actually changes the char in the string | |
// Note - StrIndex with 3 parms does not return a value | // Note - StrIndex with 3 parms does not return a value | ||
println($a); // Prints HCato | println($a); // Prints HCato | ||
| − | |||
// Print all chars | // Print all chars | ||
Revision as of 14:50, 13 December 2011
StrIndex( <expression>, <index>, <value> )
Contents |
Description
Get or set a char from/to a string at a specific index.
Parameters
expression
The string to use.
index
Index of the string to get/set data to/from.
If index is lower than 0 it becomes 0 and if its higher than strings length it becomes the strings length.
So it will always do something.
value
Optional; If this param exists it will set the CHAR value of this param to the string at the given index.
OTHERWISE it will return the char at the index.
Return Value
Success: Returns the char at the given index IF only 2 params are used.
Success: Returns 1 IF 3 params are used.
Failure: Returns empty string IF only 2 params are used.
Failure: Returns 0 IF 3 params are used.
Remarks
When setting a char at a given Index it modifies the string in place and does not create a new one.
Example
// Set a string $a = "Hello"; // This is one of the few functions // that will modify the value directly // rather than return it modified. StrIndex($a, 1, "C"); // Actually changes the char in the string StrIndex($a, 2, "a"); // Actually changes the char in the string StrIndex($a, 3, "t"); // Actually changes the char in the string // Note - StrIndex with 3 parms does not return a value println($a); // Prints HCato // Print all chars for($i = 0; $i < StrLen($a); $i++) { println( StrIndex($a, $i) ); // StrIndex with 2 params only READS the strings chars // It does not modify them } // Print all chars using the [] // The $a[$i] works to GET chars but it wont work to SET chars // This is because of how strings are handled in Sputnik it // would simply become an array if you tried to set data to that position // but getting data from it is no problem for($i = 0; $i < StrLen($a); $i++) { println( $a[$i] ); }
