CreateSSLNetworkSocket Method of the IFWXFirewall2 Interface

The CreateSSLNetworkSocket method creates an SSL socket object that works with the dynamic packet filtering scheme.

Syntax

HRESULT CreateSSLNetworkSocket(
  [in]   BOOL fAskForClientCert,
  [in]   LPSTR pszHostName,
  [in]   DWORD dwHostNameLen,
  [in]   LONG* pCreds,
  [in]   LONG* pDefaultCreds,
  [in]   FwxSSLSocketSide eSide,
  [in]   DWORD dwDefaultSendTimeout,
  [in]   DWORD dwDefaultRecvTimeout,
  [in]   BOOL fAllowHTTPSTunnelingMode,
  [out]  IFWXNetworkSocket** ppiSslSocket
);

Parameters

fAskForClientCert

Boolean value that specifies whether a client certificate is requested.

pszHostName

Pointer to a null-terminated string containing the name of the server you are trying to connect to. The pszHostName parameter is needed for authentication.

dwHostNameLen

The length of the host name.

pCreds

Pointer to a 32-bit integer that specifies the credentials of the socket creator.

pDefaultCreds

Pointer to a 32-bit integer that specifies the default credentials, which do not include a user name.

eSide

Value from the FwxSSLSocketSide enumerated type that specifies whether the socket is on the server side or client side of Forefront TMG.

Value	Meaning
eServerSide	The socket is on the server side.
eClientSide	The socket is on the client side.

dwDefaultSendTimeout

The default send time-out period.

dwDefaultRecvTimeout

The default receive time-out period.

fAllowHTTPSTunnelingMode

Boolean value that specifies whether HTTPS (SSL) tunneling mode is allowed.

ppiSslSocket

Address of an interface pointer that on return points to the IFWXNetworkSocket interface created.

Return Value

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

Requirements

Server	Requires Windows Server 2008.
Version	Requires Forefront Threat Management Gateway (TMG).
Header	Declared in Wspfwext.idl.
DLL	Requires Wspsrv.exe.

See Also

IFWXFirewall2

Send comments about this topic to Microsoft

Build date: 11/30/2009