List clients

To get a list of all currently visible clients on the specified virtual server

unsigned int ts3client_getClientList(uint64 serverConnectionHandlerID, anyID **result)

Get a list of all clients in subscribed channels on the server.

Parameters:
  • serverConnectionHandlerID – connection handler on which to retrieve the client list

  • result – address of a variable to receive a null terminated array of client ids like {10, 30, …, 0} Memory is allocated by the client lib and caller must free the array using ts3client_freeMemory

Returns:

An Error code from the Ts3ErrorType enum indicating either success or the failure reason

To get a list of all clients in the specified channel if the channel is currently subscribed:

unsigned int ts3client_getChannelClientList(uint64 serverConnectionHandlerID, uint64 channelID, anyID **result)

Get a list of all clients in the specified channel.

Parameters:
  • serverConnectionHandlerID – connection handler on which the channel is located

  • channelID – the channel of which to retrieve the current clients

  • result – address of a variable to receive a zero terminated array of client ids, like {2, 50, 4, …, 0} Memory is allocated by the client lib and must be freed by caller using ts3client_freeMemory

Returns:

An Error code from the Ts3ErrorType enum indicating either success or the failure reason