GetClientSession Method of the IFWXFirewall Interface

The GetClientSession method retrieves or, if necessary, creates a session object for a specified client address.


HRESULT GetClientSession(
  [in]   LPSOCKADDR Address,
  [in]   DWORD AddressLength,
  [out]  IFWXSession** ppiClientSession



Pointer to a sockaddr structure that contains the address of the client for which the session object is needed. The port is ignored.


Length, in bytes, of the structure pointed to by the Address parameter.


Address of an interface pointer that on return points to the IFWXSession interface on the session object for the client address specified.

Return Value

This method returns S_OK if the call is successful; otherwise, it returns an error code.


Inbound primary connections can be directed to a SecureNAT client by using the IFWXFirewall::CreatePrivateSession or IFWXFirewall::GetClientSession method. Use the IFWXFirewall::CreatePrivateSession method when the inbound connection was requested by an application, the SecureNAT client is not known by the Microsoft Firewall service, and no session object has been created. Use the IFWXFirewall::GetClientSession method only if the filter can assert that the client is configured to be a SecureNAT client of that server.


Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).

Declared in Wspfwext.idl.


Requires Wspsrv.exe.

See Also


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.