SDL Wiki
(This function is part of SDL_net, a separate library from SDL.)

SDLNet_DelSocket

Remove a socket from a set of sockets to be checked for available data.

Header File

Defined in <SDL_net.h>

Syntax

int SDLNet_DelSocket(SDLNet_SocketSet set, SDLNet_GenericSocket sock);

Function Parameters

SDLNet_SocketSet set the socket set to remove a socket from.
SDLNet_GenericSocket sock the socket to remove from the set.

Return Value

(int) Returns the total number of sockets contained in the set (after sock's removal), or -1 if sock was not in the set.

Remarks

Generally you don't want to call this generic function, but rather the specific, inline function that wraps it: SDLNet_TCP_DelSocket() or SDLNet_UDP_DelSocket().

If sock is NULL, nothing is removed from the set; this lets you query the number of sockets currently contained in the set.

This will return -1 if the socket was not found in the set; in such a case, nothing is removed from the set.

Version

This function is available since SDL_net 2.0.0.

See Also


CategoryAPI, CategoryAPIFunction


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.