# $mask

Retrieve the mask of an 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@*.host.top (nick!user@XXX.XXX.XXX.*)
2 : nick!user@*
3 : nick!*@machine.host.top (nick!user@XXX.XXX.XXX.XXX)
4 : nick!*@*.host.top (nick!user@XXX.XXX.XXX.*)
5 : nick!*@*
6 : *!user@machine.host.top (*!user@XXX.XXX.XXX.XX)
7 : *!user@*.host.top (*!user@XXX.XXX.XXX.*)
8 : *!user@*
9 : *!*@machine.host.top (*!*@XXX.XXX.XXX.XXX)
10: *!*@*.host.top (*!*@XXX.XXX.XXX.*)
11: nick!*user@machine.host.top (nick!*user@XXX.XXX.XXX.XXX)
12: nick!*user@*.host.top (nick!*user@XXX.XXX.XXX.*)
13: nick!*user@*
14: *!*user@machine.host.top (*!*user@XXX.XXX.XXX.XXX)
15: *!*user@*.host.top (*!*user@XXX.XXX.XXX.*)
16: *!*user@*
If some data is missing , these types may change:
For example , if 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.

See also
option,

Main index, Function index

KVirc 3.0.0 documentation
Generated by root at Thu Apr 29 12:41:05 2004