Semiconductor & Computer Engineering
$bvar returns the contents of a binary variable. Default is returning the contents as decimal ASCII values.
Synopsis
$bvar(&binvar, [ N [ ,M] ] )
Parameters
- &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.
- 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
- text - Changes output from decimal ASCII numbers to text characters
- word - Outputs decimal value of a 2-byte word, seeing bytes in little-endian order (low value first)
- nword - Outputs decimal value of a 2-byte word, seeing bytes in big-endian order (high value first)
- long - Outputs decimal value of a 4-byte dword (unsigned long), seeing bytes in little-endian order (low value first)
- nlong - Outputs decimal value of a 4-byte dword (unsigned long), seeing bytes in big-endian 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 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
//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 /
//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 169 // chloé / chloé //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 169 // chloé / chloé //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 169 // loé / ch //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 169 // loé
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 word $base(%word,10,16) nword $base(%nword,10,16) long $base(%long,10,16) nlong $base(%nlong,10,16) 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 word %word $base(%word,10,16) nword %nword $base(%nword,10,16) long %long $base(%long,10,16) nlong %nlong $base(%nlong,10,16) 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 $base($bvar(&abc,1).long,10,16) 40302010 //bset &abc 1 16 32 48 64 128 144 160 176 | echo -a $base($bvar(&abc,2).long,10,16) 80403020
Compatibility
Added: mIRC v5.3
Added on: 13 Dec 1997
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.