Kicks clients from a server.

BOOL BASS_Encode_ServerKick(
    HENCODE handle,
    char *client


handleThe encoder handle.
clientThe address of the client(s) to kick... NULL (or empty string) = all clients. This should be an IPv4 or IPv6 address, optionally with a port number or netmask. If a port is not specified then all ports connected from the IP address are kicked. A netmask may be specified in CIDR notation to kick a block of IP addresses.

Return value

If successful, TRUE is returned, else FALSE is returned. Use BASS_ErrorGetCode to get the error code.

Error codes

BASS_ERROR_HANDLEhandle is not valid.
BASS_ERROR_NOTAVAILNo matching clients were found.


The clients may not be kicked immediately, but shortly after the call. If the server has been setup with an ENCODECLIENTPROC callback function then that will receive notification of the disconnections.


Kick a client connected from port 1234 at
BASS_Encode_ServerKick(encoder, "");

Kick all clients connected from

BASS_Encode_ServerKick(encoder, "");

Kick all clients connected from 1.2.3.x.

BASS_Encode_ServerKick(encoder, "");

See also