envoy_envoy

HostRequestA()

Synopsis

BOOL HostRequestA(
         struct TagItem * tags );

BOOL HostRequest(
         TAG tag, ... );

Function

Opens a requester listing the hosts that answer an NIPC inquiry
and lets the user pick or type one. With realms configured the
middle button lists the realms instead, and a "realm:" prefix in
the string gadget lists that realm's hosts.

Inputs

tags - HREQ_#? tags and any MATCH_#? inquiry tags, which restrict
       the hosts shown.

Result

TRUE when a host was chosen and copied to HREQ_Buffer as "host" or
"realm:host"; FALSE on Cancel or failure.

Notes

The buffer is always NUL-terminated within HREQ_BuffSize.

LoginRequestA()

Synopsis

BOOL LoginRequestA(
         struct TagItem * tags );

BOOL LoginRequest(
         TAG tag, ... );

Function

Asks for a user name and a password. The name is preset from
LREQ_UserName or, failing that, the global variable USERNAME.

Inputs

tags - LREQ_#? tags.

Result

TRUE with the name in LREQ_NameBuff and the password in
LREQ_PassBuff (each NUL-terminated within its length), FALSE on
Cancel or failure. Empty entries are accepted; checking them is the
caller's business.

PasswordRequestA()

Synopsis

BOOL PasswordRequestA(
         struct TagItem * tags );

BOOL PasswordRequest(
         TAG tag, ... );

Function

Asks for a new password, typed twice. With PWREQ_OldPassword the
old one has to be typed as well; it is checked here unless
PWREQ_OldPWLen makes that tag a buffer for the caller to check.
The OK button is enabled only while the entries are acceptable.

Inputs

tags - PWREQ_#? tags.

Result

TRUE with the new password in PWREQ_NewPWBuff (and the typed old
one in PWREQ_OldPassword when PWREQ_OldPWLen is set), FALSE on
Cancel or failure.

UserRequestA()

Synopsis

BOOL UserRequestA(
         struct TagItem * tags );

BOOL UserRequest(
         TAG tag, ... );

Function

Lists the users (UGREQ_UserBuff given) and/or groups
(UGREQ_GroupBuff given) known to accounts.library, or the names in
UGREQ_UserList/UGREQ_GroupList, and lets the user pick one.

Inputs

tags - UGREQ_#? tags.

Result

TRUE on OK or a double click, FALSE on Cancel or failure. The chosen
name is in UGREQ_UserBuff or UGREQ_GroupBuff; the other buffer is
empty. Both buffers are emptied when the requester starts and follow
every selection, so they hold the last selection even after Cancel.