SetConnectivityRequest Method of the IFPCConnectivityVerifier Interface

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

[C++]

Syntax

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

Parameters

ServerAddress

String value that specifies the address of the server to which connectivity is to be verified.

RequestType

Value from the FpcRequestType enumerated type that specifies the type of request to be used in the verification operation of the connectivity verifier.

TCPPort

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

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

Syntax

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

Parameters

ServerAddress

String value that specifies the address of the server to which connectivity is to be verified.

RequestType

Value from the FpcRequestType enumerated type that specifies the type of request to be used in the verification operation of the connectivity verifier.

TCPPort

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

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

Example Code

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.

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.

Requirements

Client Requires Windows Vista or Windows XP.
Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
IDL

Declared in Msfpccom.idl.

DLL

Requires Msfpccom.dll.

See Also

FPCConnectivityVerifier


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.

[an error occurred while processing this directive]