IFWXFirewall::GetHostByName method

Article
08/27/2012

Applies to: desktop apps only

The GetHostByName method retrieves host information corresponding to a host name. This method is similar to the Winsock gethostbyname function.

Syntax

HRESULT GetHostByName(
  [in]       const char *name,
  [out]      char *buf,
  [in, out]  int *buflen
);

Parameters

name [in]
Pointer to a null-terminated string that specifies the name of the host. UTF-8 encoding is expected in this parameter.
buf [out]
Pointer to the data area to receive the hostent data. The data area must be larger than the size of a hostent structure because the supplied data area is used by Windows Sockets to contain a hostent structure and all of the data referenced by members of the hostent structure. A buffer of MAXGETHOSTSTRUCT bytes is recommended. The strings returned in the structure are encoded using the current system ANSI code page (ACP).
buflen [in, out]
On input, specifies the size of data area for the buf parameter. If the buffer is too small, the error code HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) is returned and the buflen parameter receives the size of the required buffer.

Return value

This method can return one of these values.

S_OK
Success, the buffer was filled with the host information.
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)
Insufficient buffer space was provided. That is, the buffer pointed to by the buf parameter is not large enough to contain the host information. For more information, see the description of the buflen parameter.
HRESULT_FROM_WIN32(WSAHOST_NOT_FOUND)
The name specified could not be found in the relevant database.
HRESULT_FROM_WIN32(WSATRY_AGAIN)
No response was received from an authoritative server.
HRESULT_FROM_WIN32(WSANO_DATA)
The name specified is valid and was found in the database, but no information of the type requested is associated with it.

Remarks

Unlike the IFWXSession::GetHostByName method, this method does not check permissions or policy rules, does not log the name resolution, and cannot use autodial to dial out for the name resolution.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
Header	Wspfwext.idl
DLL	Wspsrv.exe

Share via