# $mask

Retrieves the host mask of a user

Syntax

    $mask[(<nickname>[,<mask_type>])]

Description

Returns the specified type of mask for the user with <nickname>.
If the host or username are not known, the mask may contain less information than requested.
If the <nickname> is not given it is assumed to be the current nickname.
If <mask_type> is not given or is invalid, it is assumed to be 0.
Available mask types:
0 : nick!user@machine.host.top (nick!user@XXX.XXX.XXX.XXX) (default)
1 : nick!user@*.abc.host.top (nick!user@XXX.XXX.XXX.*)
2 : nick!user@*
3 : nick!*@machine.host.top (nick!user@XXX.XXX.XXX.XXX)
4 : nick!*@*.abc.host.top (nick!user@XXX.XXX.XXX.*)
5 : nick!*@*
6 : *!user@machine.host.top (*!user@XXX.XXX.XXX.XX)
7 : *!user@*.abc.host.top (*!user@XXX.XXX.XXX.*)
8 : *!user@*
9 : *!*@machine.host.top (*!*@XXX.XXX.XXX.XXX)
10: *!*@*.abc.host.top (*!*@XXX.XXX.XXX.*)
11: nick!*user@machine.host.top (nick!*user@XXX.XXX.XXX.XXX)
12: nick!*user@*.abc.host.top (nick!*user@XXX.XXX.XXX.*)
13: nick!*user@*
14: *!*user@machine.host.top (*!*user@XXX.XXX.XXX.XXX)
15: *!*user@*.abc.host.top (*!*user@XXX.XXX.XXX.*)
16: *!*user@*
17: nick!~user@*.host.top (nick!~user@XXX.XXX.*)
18: nick!*@*.host.top (nick!*@XXX.XXX.*)
19: *!~user@*.host.top (*!~user@XXX.XXX.*)
20: nick!*user@*.host.top (nick!*user@XXX.XXX.*)
21: *!*user@*.host.top (*!user@*XXX.XXX.*)
22: nick!~user@*.host.top (nick!~user@XXX.XXX.*)
23: nick!*@*.host.top (nick!*@XXX.XXX.*)
24: *!~user@*.host.top (*!~user@XXX.XXX.*)
25: nick!*user@*.host.top (nick!*user@XXX.XXX.*)
26: *!*user@*.host.top (*!user@*XXX.XXX.*)
If some data is missing, these types may change:
For example, if the hostname is missing, the mask type 3 or 4 may be reduced to type 5.
If the user with <nickname> is not found in the current IRC context user database, an empty string is returned.
The masks 22-26 are the smart versions of the masks 17-21 that try take care of masked ip addresses in the form xxx.xxx.INVALID-TOP-MASK. If a masked ip address is found then the XXX.XXX.* or XXX.* host mask is returned instead of the (wrong) *.INVALID-TOP-MASK

Index, Functions

KVIrc 3.2.0 Documentation
Generated by root at Thu Mar 9 08:43:54 2006