BIS fnc findInPairs: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *K([a-z ])" to "$1 - k$2")
 
(34 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|gr1= Arrays


|0.76|= Game version
|descr= Searches the associative array for the first occurance of the key string and returns its index. Seach is not case-sensitive.
____________________________________________________________________________________________


| <pre>/*
|s1= [array, key] call [[BIS_fnc_findInPairs]]


Description:
|p1= array: [[Array]] - array to search through
Searches the associative array for the 1st occurance of the key string and returns it's index.


Syntax:
|p2= key: [[String]] - key to search for
_index:number = [_associativeArray:array,_key:string] call BIS_fnc_findInPairs;


Example:
|r1= [[Number]] - index of first occurence
0 = [[["apple",3],["pear",2]],"apple"] call BIS_fnc_findInPairs;


Returns:
|x1= <sqf>[[["apple",3],["pear",2]],"apple"] call BIS_fnc_findInPairs; // Returns 0</sqf>
* if found: index (starting from 0)
* if not found: -1
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |DESCRIPTION=
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_findInPairs]]; --> |SYNTAX=
 
|p1= |= Parameter 1
 
| |RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |SEEALSO=


|seealso= [[find]] [[findIf]] [[BIS_fnc_getFromPairs]] [[BIS_fnc_addToPairs]] [[BIS_fnc_removeFromPairs]] [[BIS_fnc_setToPairs]]
}}
}}
<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: Arrays|{{uc:findInPairs}}]]
[[Category:Functions|{{uc:findInPairs}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:findInPairs}}]]

Latest revision as of 15:37, 8 November 2023

Arma 3 logo black.png0.76
Hover & click on the images for description

Description

Description:
Searches the associative array for the first occurance of the key string and returns its index. Seach is not case-sensitive.
Execution:
call
Groups:
Arrays

Syntax

Syntax:
[array, key] call BIS_fnc_findInPairs
Parameters:
array: Array - array to search through
key: String - key to search for
Return Value:
Number - index of first occurence

Examples

Example 1:
[[["apple",3],["pear",2]],"apple"] call BIS_fnc_findInPairs; // Returns 0

Additional Information

See also:
find findIf BIS_fnc_getFromPairs BIS_fnc_addToPairs BIS_fnc_removeFromPairs BIS_fnc_setToPairs

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_findInPairs&oldid=348806"