Login

Logs in to the BVE API server.

$return_value = $obj->Login();

This method opens a TCP connection to $tcp_port on $host_name_or_ip, as defined using the new method. If either the $login_id argument or the $login_pass argument is missing, the values specified in the new method (if any) are used.

An optional named argument is provided to override the current timeout setting. On timeout or other connection errors, the return value is 0 and details on the error are available via the GetErrorMsg method. On success, a non-zero return value is provided.

This method can be used repeatedly to switch to a different user in the BVE API server and assume the new user's permissions and privileges.