Variables and function parameters described in this macro guide are named using the following conventions.
Name |
Meaning |
s and sz |
a string |
ch |
single character string. If more than one character is in a string, only the first character is used. |
ich |
zero-based index to a character in a string or character in a line |
ichFirst |
first index in a range of characters |
ichLast |
last index in a range of characters (inclusively) |
ichLim |
limit index - one past the last index in a range |
cch |
count of characters |
fThing |
“f” means flag or boolean. fThing means “Thing” is True. |
TRUE |
a non-zero value, e.g. “1” |
FALSE |
a zero value, i.e. “0” |
ln |
zero-based line number |
lnFirst |
first line number in a range |
lnLast |
last line number in a range (inclusively) |
lnLim |
limit - one past the last line number in a range |
hbuf |
handle to a file buffer |
hwnd |
handle to a window |
hprj |
handle to a project |
hsyml |
Handle to a symbol list |
Any other names |
general string variables |