SetConnectivityRequest Method of the IFPCConnectivityVerifier Interface

[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.