WSHGetBroadcastSockaddr function

[ This function is obsolete for Windows Server 2003, Windows Vista, and later, and is no longer supported. ]

The WSHGetBroadcastSockaddr function obtains a valid broadcast address for a socket.

Syntax

INT WSHGetBroadcastSockaddr(
  _In_  PVOID     HelperDllSocketContext,
  _Out_ PSOCKADDR Sockaddr,
  _Out_ PINT      SockaddrLength
);

Parameters

• HelperDllSocketContext [in]
  Pointer to a per-socket context area, allocated and initialized by the WSH DLL WSHOpenSocket2 function.

• Sockaddr [out]
  Pointer to a buffer in which WSHGetBroadcastSockaddr returns a valid broadcast address, formatted as a SOCKADDR structure.

• SockaddrLength [out]
  Pointer to a variable in which WSHGetBroadcastSockaddr returns the number of bytes it set in the SOCKADDR structure.

Return value

WSHGetBroadcastSockaddr returns NO_ERROR to indicate success, or WSAEFAULT to indicate that the buffer at Sockaddr is insufficient in size to contain a full SOCKADDR structure.

Requirements

Send comments about this topic to Microsoft