DeleteUser Method  
 

Remove a virtual user from the server.

Syntax

object.DeleteUser( HostId, UserName )

Parameters

HostId
An integer value which identifies the virtual host.
UserName
A string which specifies the user name to be deleted. Usernames are not case sensitive.

Return Value

A value of zero is returned if the virtual user was deleted. Otherwise, a non-zero error code is returned which indicates the cause of the failure.

Remarks

The DeleteUser method removes a virtual user that was created by a previous call to the AddUser method. This method will not match partial usernames and wildcard characters cannot be used to delete multiple users. Usernames are not case sensitive.

See Also

AddUser Method, Authenticate Method, OnAuthenticate Event