From WikiChip
Editing mirc/identifiers/$bvar

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

This page supports semantic in-text annotations (e.g. "[[Is specified as::World Heritage Site]]") to build structured and queryable content provided by Semantic MediaWiki. For a comprehensive description on how to use annotations or the #ask parser function, please have a look at the getting started, in-text annotation, or inline queries help pages.

Latest revision Your text
Line 1: Line 1:
−
{{mirc title|$bvar Identifier}}'''$bvar''' returns the contents of a binary variable. Default is returning the contents as decimal byte values in the range 0-255.
+
{{mirc title|$bvar Identifier}}'''$bvar''' returns the contents of a binary variable. Default is returning the contents as decimal ASCII values.
−
 
 
−
'''Note''': $bvar(&var) used without N or M parameters returns the variable name if it exists, otherwise returns $null, this has to be used to check if a binary variable exists before checking $bvar(&bvar,0) to check if it has data.
 
−
 
 
 
== Synopsis ==
 
== Synopsis ==
 
<pre>$bvar(&binvar, [ N [ ,M] ] )</pre>
 
<pre>$bvar(&binvar, [ N [ ,M] ] )</pre>
Line 8: Line 5:
 
== Parameters ==
 
== Parameters ==
 
* '''&binvar''' - A binary variable name which begins with the & symbol.
 
* '''&binvar''' - A binary variable name which begins with the & symbol.
−
* '''N''' - The beginning position within the binary variable. N=0 returns the length of the binary variable. Can also be range, N- or N1-N2. (First byte is pos 1 not offset 0)
+
* '''N''' - The beginning position within the binary variable. N=0 returns the length of the binary variable. Can also be range, N- or N1-N2.
−
* '''M''' - Optional length of the number of values to return. If there are not M bytes beginning at the Nth position, returns all the remaining bytes beginning at the Nth position.
+
* '''M''' - Optional limit of the number of values to return. If there are not M bytes beginning at the Nth position, returns all the bytes beginning at the Nth position.
 +
 
 
== Properties ==
 
== Properties ==
−
* '''.text''' - returns a string from the bytes, bytes are decoded from utf8
+
* '''text''' - Changes output from decimal ASCII numbers to text characters
−
* '''.ansi''' - returns a string from the bytes, bytes are not decoded from utf8
+
* '''word''' - Outputs decimal value of a 2-byte word, seeing bytes in little-endian order (low value first)
−
* '''.word''' - Outputs decimal value of a 2-byte word, seeing bytes in little-endian byte order (low value first)
+
* '''nword''' - Outputs decimal value of a 2-byte word, seeing bytes in big-endian order (high value first)
−
* '''.nword''' - Outputs decimal value of a 2-byte word, seeing bytes in big-endian byte order (high value first)
+
* '''long''' - Outputs decimal value of a 4-byte dword (unsigned long), seeing bytes in little-endian order (low value first)
−
* '''.long''' - Outputs decimal value of a 4-byte dword (unsigned long), seeing bytes in little-endian byte order (low value first)
+
* '''nlong''' - Outputs decimal value of a 4-byte dword (unsigned long), seeing bytes in big-endian order (high value first)
−
* '''.nlong''' - Outputs decimal value of a 4-byte dword (unsigned long), seeing bytes in big-endian byte order (high value first)
 
  
 +
Note: Used without N or M parameters returns the variable name if it exists, otherwise $null
  
−
'''Note''': word/nword/long/nlong return non-byte values ONLY when M is not used and N is a positive integer without a hyphen, and do not return a series of numbers from a lengthy variable. They return the value from the 2 or 4 bytes beginning at the Nth byte, and returns $null if there are not the needed 2 or 4 bytes to completely fill the word/long.
+
Note: word/nword/long/nlong work ONLY when N is a positive integer, and do not return a series of numbers from a lengthy variable. They return the value of the 2 or 4 bytes beginning at the Nth byte, and returns $null if there are not the needed 2 or 4 bytes to completely fill the word/long. The last 4 .props are also ignored if the 3rd "M" parameter is used with any value other than 1, returning instead the value as if no property were used.
  
 
== Example ==
 
== Example ==
−
<source lang="mIRC">//bset &abc 1 12 34 56 78 | echo -a $iif($bvar(&abc),$v1 exists) $iif($bvar(&xyz),$v1 exists) / $bvar(&abc) / $bvar(&xyz)
+
<source lang="mIRC">//bset &abc 1 11 22 33 44 | echo -a $iif($bvar(&abc),$v1 exists) $iif($bvar(&xyz),$v1 exists) / $bvar(&abc) / $bvar(&xyz)
−
  &abc exists / &abc /</source>
+
&abc exists / &abc /</source>
  
 
<source lang="mIRC">
 
<source lang="mIRC">
−
//bset -ta &var 1 chlo $+ $chr(232) / $utfencode(chlo $+ $chr(232) )  | echo -a $bvar(&var,1-) // $bvar(&var,1-).text
+
//bset -ta &var 1 chlo $+ $chr(233) / $utfencode(chlo $+ $chr(233) )  | echo -a $bvar(&var,1-) // $bvar(&var,1-).text
−
  99 104 108 111 233 32 47 32 99 104 108 111 195 168 // chloè / chloè
+
99 104 108 111 233 32 47 32 99 104 108 111 195 169 // chloé / chloé
−
//bset -t  &var 1 chlo $+ $chr(232) / $utfencode(chlo $+ $chr(232) )  | echo -a $bvar(&var,1-) // $bvar(&var,1-).text
+
//bset -t  &var 1 chlo $+ $chr(233) / $utfencode(chlo $+ $chr(233) )  | echo -a $bvar(&var,1-) // $bvar(&var,1-).text
−
  99 104 108 111 195 169 32 47 32 99 104 108 111 195 131 194 168 // chloè / chloè
+
99 104 108 111 195 169 32 47 32 99 104 108 111 195 131 194 169 // chloé / chloé
−
//bset -t  &var 1 chlo $+ $chr(232) / $utfencode(chlo $+ $chr(233) )  | echo -a $bvar(&var,1-) // $bvar(&var,3-11).text
+
//bset -t  &var 1 chlo $+ $chr(233) / $utfencode(chlo $+ $chr(233) )  | echo -a $bvar(&var,1-) // $bvar(&var,3-11).text
−
  99 104 108 111 195 169 32 47 32 99 104 108 111 195 131 194 168 // loè / ch
+
99 104 108 111 195 169 32 47 32 99 104 108 111 195 131 194 169 // loé / ch
−
//bset -t  &var 1 chlo $+ $chr(232) / $utfencode(chlo $+ $chr(232) )  | echo -a $bvar(&var,1-) // $bvar(&var,3-11,5).text
+
//bset -t  &var 1 chlo $+ $chr(233) / $utfencode(chlo $+ $chr(233) )  | echo -a $bvar(&var,1-) // $bvar(&var,3-11,5).text
−
  99 104 108 111 195 169 32 47 32 99 104 108 111 195 131 194 168 // loè
+
99 104 108 111 195 169 32 47 32 99 104 108 111 195 131 194 169 // loé
 
</source>
 
</source>
  
 
<source lang="mIRC">
 
<source lang="mIRC">
−
Note: showing base-16 values to better visualize the little-endian/big-endian byte changes
+
Note: showing base-16 values to better visualize the little-endian/big-endian changes
−
//bset &abc 1 231 32 33 34 35 36 37 38 | var %word = $bvar(&abc,1).word , %nword = $bvar(&abc,1).nword , %long = $bvar(&abc,1).long | var %nlong $bvar(&abc,1).nlong | echo -a in hex: word $base(%word,10,16) nword $base(%nword,10,16) long $base(%long,10,16) nlong $base(%nlong,10,16)
+
//bset &abc 1 231 32 33 34 35 36 37 38 | var %word = $bvar(&abc,1).word , %nword = $bvar(&abc,1).nword , %long = $bvar(&abc,1).long | var %nlong $bvar(&abc,1).nlong | echo -a word $base(%word,10,16) nword $base(%nword,10,16) long $base(%long,10,16) nlong $base(%nlong,10,16)
−
  in hex: word 20E7 nword E720 long 222120E7 nlong E7202122
+
word 20E7 nword E720 long 222120E7 nlong E7202122
−
//bset &abc 1 16 32 48 64 | var %word = $bvar(&abc,1).word , %nword = $bvar(&abc,1).nword , %long = $bvar(&abc,1).long | var %nlong $bvar(&abc,1).nlong | echo -a in hex: word %word $base(%word,10,16) nword %nword $base(%nword,10,16) long %long $base(%long,10,16) nlong %nlong $base(%nlong,10,16)
+
//bset &abc 1 16 32 48 64 | var %word = $bvar(&abc,1).word , %nword = $bvar(&abc,1).nword , %long = $bvar(&abc,1).long | var %nlong $bvar(&abc,1).nlong | echo -a word %word $base(%word,10,16) nword %nword $base(%nword,10,16) long %long $base(%long,10,16) nlong %nlong $base(%nlong,10,16)
−
in hex: word 8208 2010 nword 4128 1020 long 1076895760 40302010 nlong 270544960 10203040
+
word 8208 2010 nword 4128 1020 long 1076895760 40302010 nlong 270544960 10203040
−
//bset &abc 1 16 32 48 64 128 144 160 176 | echo -a in hex: $base($bvar(&abc,1).long,10,16)
+
//bset &abc 1 16 32 48 64 128 144 160 176 | echo -a $base($bvar(&abc,1).long,10,16)
−
  in hex: 40302010
+
40302010
 
//bset &abc 1 16 32 48 64 128 144 160 176 | echo -a $base($bvar(&abc,2).long,10,16)
 
//bset &abc 1 16 32 48 64 128 144 160 176 | echo -a $base($bvar(&abc,2).long,10,16)
−
  80403020
+
80403020
−
 
 
−
//bset -t &abc 1 abcdefghi | echo -a $bvar(&abc,3-) / $bvar(&abc,3).word $calc($bvar(&abc,4)*256+$bvar(&abc,3))  / $bvar(&abc,3).nword $calc($bvar(&abc,3)*256+$bvar(&abc,4))
 
−
  99 100 101 102 103 104 105 / 25699 25699 / 25444 25444
 
−
 
 
−
The order swap is by byte not bit. If hex of .long is 0xdeadbeef then .nlong is 0xefbeadde
 
−
//bset &abc 1 $base(ef,16,10) $base(be,16,10) $base(ad,16,10) $base(de,16,10) | echo -a $base($bvar(&abc,1).long,10,16) $base($bvar(&abc,1).nlong,10,16)
 
 
</source>
 
</source>
−
 
 
== Compatibility ==
 
== Compatibility ==
 
{{mIRC compatibility|5.3}}
 
{{mIRC compatibility|5.3}}

Please note that all contributions to WikiChip may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see WikiChip:Copyrights for details). Do not submit copyrighted work without permission!

Cancel | Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://en.wikichip.org/wiki/mirc/identifiers/$bvar"