Microsoft Internet Security and Acceleration Server 2004 SDK

IFPCConnectivityVerifier::SetConnectivityRequest[C++]

FPCConnectivityVerifier.SetConnectivityRequest [Visual Basic]

[C++]

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

HRESULT SetConnectivityRequest(
  BSTR ServerAddress,
  FpcRequestType RequestType,
  long TCPPort
);

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 of the server to which connectivity is to be verified. This parameter should be set only if the RequestType parameter is set to fpcTcpConnect.

Return Values

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

Remarks

If the value of the RequestType parameter is set to fpcHttpConnect, a system policy rule, named Allow HTTP/HTTPS requests from ISA Server 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 on how to enable a system policy rule by enabling its configuration group, see the Enabled property of the FPCSystemPolicyConfigGroup object.

[Visual Basic]

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

Sub 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 of the server to which connectivity is to be verified. This parameter should be set only if the RequestType parameter is set to fpcTcpConnect.

Return Values

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 ISA Server 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 on how to enable a system policy rule by enabling its configuration group, see the Enabled property of the FPCSystemPolicyConfigGroup object.

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.

Requirements

Server: Requires Windows Server 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Msfpccom.idl.
Library: Use Microsoft Internet Security and Acceleration Server 2004 Administration Library.

See Also

FPCConnectivityVerifier