%SS_SOCKET

Return a socket descriptor

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
status = %SS_SOCKET(socket, type[, ipv6_flag])

Return value

status

Returns SS_SUCCESS (0) or one of the errors in Error codes returned by %SS_SOCKET below. (n)

Arguments

socket

Returned with the socket descriptor. (D_ADDR)

type

One of the following communication semantics: (n)

SS_SOCK_STREAM = Stream socket

SS_SOCK_DGRAM = Datagram socket

ipv6_flag

(optional) Indicates the family of the socket to be created. Pass 0 (zero) for AF_INET (IPv4) or 1 for AF_INET6 (IPv6). If not passed, family defaults to AF_INET. (n)

Discussion

%SS_SOCKET creates a new socket descriptor of the specified type and returns it in socket. This socket descriptor is then used in other %SS_xxx and %SS2_xxx functions.

Error codes returned by %SS_SOCKET

See the Socket Errors table for additional information about these errors.

SS_EHOSTDOWN

SS_EMFILE

SS_ENETDOWN

SS_ENFILE

SS_ENOBUFS

SS_EUNKNOWN

SS_NOTINITIALISED