BIS fnc inString: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "<code> *([^<|{]*) *<\/code>" to "<sqf>$1</sqf>")
 
(38 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Strings


|1.00|= Game version
|descr=Find a string within a string.
____________________________________________________________________________________________


| <pre>/*
|s1= [searchTerm, searchText, caseSensitive] call [[BIS_fnc_inString]]
File: inString.sqf
Description:
Find a string within a string.
Parameter(s):
_this select 0: <string> string to be found
_this select 1: <string> string to search from
_this select 2 (Optional): <boolean> search is case sensitive (default: false)
Returns:
Boolean (true when string is found).
How to use:
_found = ["string", "String", true] call BIS_fnc_inString;
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p1= searchTerm: [[String]] - string to find
____________________________________________________________________________________________
|p2= searchText: [[String]] - string to search in
|p3= caseSensitive (optional): [[Boolean]] - defines whether the search is case-sensitive (true) or not (false, by default)


| <!-- [] call [[BIS_fnc_inString]]; --> |= Syntax
|r1= [[Boolean]] - true if search term is found, false if not


|p1= |= Parameter 1
|x1= <sqf>["rabbit", "I ate a rabbit today"] call BIS_fnc_inString // will return true</sqf>


| |= Return value
|x2= <sqf>["RaBbiT", "I ate a rabbit today"] call BIS_fnc_inString // will return true</sqf>
____________________________________________________________________________________________
|x3= <sqf>["RaBbiT", "I ate a rabbit today", true] call BIS_fnc_inString // will return false because of case sensitivity</sqf>
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[find]] [[BIS_fnc_filterString]] [[splitString]] [[joinString]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Strings|{{uc:inString}}]]
[[Category:Functions|{{uc:inString}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:inString}}]]

Latest revision as of 22:44, 12 July 2022

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Find a string within a string.
Execution:
call
Groups:
Strings

Syntax

Syntax:
[searchTerm, searchText, caseSensitive] call BIS_fnc_inString
Parameters:
searchTerm: String - string to find
searchText: String - string to search in
caseSensitive (optional): Boolean - defines whether the search is case-sensitive (true) or not (false, by default)
Return Value:
Boolean - true if search term is found, false if not

Examples

Example 1:
["rabbit", "I ate a rabbit today"] call BIS_fnc_inString // will return true
Example 2:
["RaBbiT", "I ate a rabbit today"] call BIS_fnc_inString // will return true
Example 3:
["RaBbiT", "I ate a rabbit today", true] call BIS_fnc_inString // will return false because of case sensitivity

Additional Information

See also:
find BIS_fnc_filterString splitString joinString

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_inString&oldid=327015"