GetSocketNumber (Socket function)

From m204wiki
Jump to navigation Jump to search

Socket number of this socket (Socket class)


This method returns a socket number for the method Socket object. The returned number can then be used with $Sock_xxx calls, so $Sock_xxx code can be used in conjunction with a Socket object.

Syntax

%number = socket:GetSocketNumber

Syntax terms

%number A numeric variable to contain the value of the number of the socket socket.
socket A variable or an expression that is a reference to a Socket object.

Usage notes

  • After GetSocketNumber returns, the Socket object is no longer valid: it is null, and the socket is only accessible by the returned number. To access the socket as an object again, you use GetSocketObject.
  • If the object returned by a GetSocketObject invocation is the method object for a subsequent GetSocketNumber invocation, the NOCLOSE setting of the original numbered socket is applied to the numbered socket returned by GetSocketNumber. For information about NOCLOSE, see Set.