IFPCConnectivityVerifier::SetConnectivityRequest method

Article
08/27/2012

Applies to: desktop apps only

The SetConnectivityRequest method sets the ServerAddress, RequestType, and TCPPort properties of the connectivity verifier object.

Syntax

HRESULT SetConnectivityRequest(
  [in]            BSTR ServerAddress,
  [in]            FpcRequestType RequestType,
  [in, optional]  long TCPPort
);

FPCConnectivityVerifier.SetConnectivityRequest( _
  ByVal ServerAddress As String, _
  ByVal RequestType As FpcRequestType, _
  [ ByVal TCPPort As Long ] _
)

Parameters

ServerAddress [in]
String value that specifies the address of the server to which connectivity is to be verified.
RequestType [in]
Value from the FpcRequestType enumerated type that specifies the type of request to be used in the verification operation of the connectivity verifier.
TCPPort [in, optional]
A 32-bit integer that specifies the TCP port on the remote server to which connectivity is to be verified. This parameter should be set only if the RequestType parameter is set to fpcTcpConnect.

Return value

C++

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

VB

This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.

Remarks

If the value of the RequestType parameter is set to fpcHttpConnect, a system policy rule, named Allow HTTP/HTTPS requests from Forefront TMG to selected servers for connectivity verifiers, which belongs to the HTTP Connectivity Verifiers configuration group, must be enabled for the connectivity verifier to work. For information about how to enable a system policy rule by enabling its configuration group, see the Enabled property of the FPCSystemPolicyConfigGroup object.

Examples

For a VBScript code example that shows how to use this method to set the request type of a new connectivity verifier, see Adding a Connectivity Verifier.

Requirements

Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
IDL	Msfpccom.idl
DLL	Msfpccom.dll

Share via