Editing mirc/identifiers/$bfind

{{mirc title|$bfind Identifier}}'''$bfind''' searches &binvar for a matching value. Returns the Nth byte position in the binvar unless .regex prop is used, in which case it returns the number of matches.
== Synopsis ==
<pre>$bfind(&binvar, N , M , [name])</pre>
== Parameters ==
* '''&binvar''' - A binary variable name which begins with the & symbol.
* '''N''' - The position within the binary variable where it starts searching.
* '''M''' - Value being searched for, either ASCII decimals 0-255 or text.
* '''name''' - an optional name to go with .regex, to be able to reference captured group later on.
== Properties ==
* '''text''' - Treats a numeric N as text instead of bytes value, also decode bytes from utf8 before searching.
* '''textcs''' - When M is recognized as text, search is performed as case-sensitive
* '''ansi''' - the bytes of the binvar are not decoded from utf8 before searching.
* '''.regex''' - performs a regex search, you can use the optional 4th name parameter to reference captured group later on. The N parameter is the Nth position in the binvar at which the input string for the regex engine starts.

Note: Searches for text are case-insensitive by default.

== Example ==
<source lang="mIRC">//bset -t &var 1 test wavmIRC32WAV test | echo -a space beginning pos1: $bfind(&var,1,32) / space beginning pos11: $bfind(&var,11,32) / finds string '32' instead of chr(32) $bfind(&var,1,32).text / case-sensitive: $bfind(&var, 1, $asc(W) $asc(A) $asc(V) ) / case-insensitive: $bfind(&var,1,WAV).text / case-sensitive: $bfind(&var,1,WAV).textcs / not found: $bfind(&var,1,abc).text

result: space beginning pos1: 5 / space beginning pos11: 18 / finds string '32' instead of chr(32) 13 / case-sensitive: 15 / case-insensitive: 6 / case-sensitive: 15 / not found: 0

Note that 32 searches for ASCII 32 (space) except when .text is used. Searching for "WAV" is case-insensitive and finds the lowercase letters, but the search for the 3 ASCII values finds the matching case. Using .textcs is available as of 7.58 to search for a case-sensitive text string without translating it to byte values.


;Note: starting position in the binvar is either N = 0 or 1
//bset -t &var 1 testing | echo -ag $bfind(&var,0,/./g).regex -- $bfind(&var,2,/^e/).regex
;7 -- 1
</source>

== Compatibility ==
{{mIRC compatibility|5.7}}

== See Also ==
{{collist
|count = 4
|style = width: 100%; display: inherit;
|
* {{mIRC|/bread}}
* {{mIRC|/bwrite}}
* {{mIRC|/bcopy}}
* {{mIRC|/bunset}}
* {{mIRC|/breplace}}
* {{mIRC|/btrunc}}
* {{mIRC|/bset}}
* {{mIRC|$bvar}}
}}