GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

IsInString Function

Overview

The IsInString function will search a target string for a matching string or character.

Syntax/Parameters

Syntax

boolean = IsInString ( string source, mixed value, [boolean case] );

boolean = IsInString ( wstring source, mixed value, [boolean case] );

Parameters

source

A string or wstring to search.

value

A string or wstring, the type must match the source, or

a char, wchar, or int to search for in source.

case

A boolean flag indicating whether to perform the search in a case-sensitive manner. The default is a TRUE indicating a case-sensitive search.

Return Value

Returns TRUE if value is found within source or FALSE if it is not.

Remarks

When searching with a string, the source and value parameters must be the same variable type.

This function is the boolean equivalent of the InString function. Do not confuse the functions since using InString as a boolean will yield unpredictable results. For example:

if (InString("abc", "a")) {

    ...    

    }

will return the value 0 as an index, which will in turn be interpreted as FALSE.

This function performs case-sensitive searching; for looser matching, use the FindInString function. 

Case-insensitive matching is performed on a locale basis as set by Windows. For US, on ASCII matching is the only case matching performed.

If the value is a string and the string is empty, the result is always FALSE.

Related Functions

BinaryCompare — Compares two variables (or literals) as binary memory.

BinaryCompareNoCase — Compares two variables (or literals) as binary characters without regard to case.

CompareStrings — Compares string a to string b and returns 0 if equal, -1 if a < b and 1 if a > b.

CompareStringsNoCase — Compares string a to string b without regard to text case and returns 0 if equal, -1 if a < b and 1 if a > b.

FindInString — Finds a string within a string with optional position and case sensitivity.

IsRegexMatch — Performs a regular expression pattern match on string data.

InString — Tests for a string as part of a target string with or without case sensitivity.

ScanString — Scans a string as a list delimited by spaces, commas, or line endings.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

Page revised 2024-12-13

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.