WSAHtonl function (winsock2.h)
The WSAHtonl function converts a u_long from host byte order to network byte order.
Syntax
int WSAAPI WSAHtonl(
[in] SOCKET s,
[in] u_long hostlong,
[out] u_long *lpnetlong
);
Parameters
[in] s
A descriptor identifying a socket.
[in] hostlong
A 32-bit number in host byte order.
[out] lpnetlong
A pointer to a 32-bit number to receive the number in network byte order.
Return value
If no error occurs, WSAHtonl returns zero. Otherwise, a value of SOCKET_ERROR is returned, and a specific error code can be retrieved by calling WSAGetLastError.
| Error code | Meaning |
|---|---|
| A successful WSAStartup call must occur before using this function. | |
| The network subsystem has failed. | |
| The descriptor is not a socket. | |
| The lpnetlong parameter is NULL or the address pointed to is not completely contained in a valid part of the user address space. |
Remarks
The WSAHtonl function takes a 32-bit number in host byte order and returns a 32-bit number in network byte order in the 32-bit number pointed to by the lpnetlong parameter. The socket passed in the s parameter is used to determine the network byte order required based on the Winsock catalog protocol entry associated with the socket. This feature supports Winsock providers that use different network byte orders.
If the socket is for the AF_INET or AF_INET6 address family, the WSAHtonl function can be used to convert an IPv4 address in host byte order to the IPv4 address in network byte order. This function does not do any checking to determine if the hostlong parameter is a valid IPv4 address.
The WSAHtonl function requires that the Winsock DLL has previously been loaded with a successful call to the WSAStartup function. For use with the AF_INET or AF_INET6 family, the htonl function does not require that the Winsock DLL be loaded.
Windows Phone 8: This function is supported for Windows Phone Store apps on Windows Phone 8 and later.
Windows 8.1 and Windows Server 2012 R2: This function is supported for Windows Store apps on Windows 8.1, Windows Server 2012 R2, and later.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8.1, Windows Vista [desktop apps | UWP apps] |
| Minimum supported server | Windows Server 2003 [desktop apps | UWP apps] |
| Target Platform | Windows |
| Header | winsock2.h |
| Library | Ws2_32.lib |
| DLL | Ws2_32.dll |