IFPCBackupRoute::SetAutoPollConfig method

Applies to: desktop apps only

The SetAutoPollConfig method sets the configuration for automatic polling of the upstream proxy server on the backup route for information about the availability of upstream array members.

Syntax

HRESULT SetAutoPollConfig(
  [in]            VARIANT_BOOL fSetAuto,
  [in, optional]   AutoPollUrl,
  [in, optional]  BSTR AutoPollUrl
);
FPCBackupRoute.SetAutoPollConfig( _
  ByVal fSetAuto As Boolean, _
  [ ByVal AutoPollUrl As String ], _
  [ ByVal AutoPollUrl ] _
)

Parameters

  • fSetAuto [in]
    Boolean value that indicates whether polling of the upstream server for information about the availability of upstream array members on the backup route is enabled.

  • AutoPollUrl [in, optional]

    C++

    BSTR that specifies the URL, usually at the upstream proxy, for polling for information about the availability of upstream array members on the backup route. If fSetAuto is set to VARIANT_TRUE, this parameter must hold a valid URL; otherwise, this parameter is ignored.

    VB

    String value that specifies the URL, usually at the upstream proxy server, for polling for information about the availability of upstream array members on the backup route. If fSetAuto is set to True, this parameter must hold a valid URL; otherwise, this parameter is ignored.

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

This method sets the AutomaticPollConfig and PollAtURL properties.

Polling for information about the availability of upstream array members should be enabled only if the upstream proxy server on the backup route is a member of an array with two or more members.

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

See also

FPCBackupRoute

 

 

Build date: 7/12/2010