SetAutoPollConfig Method of the IFPCBackupRoute Interface

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.

[C++]

Syntax

HRESULT SetAutoPollConfig(
  [in]			VARIANT_BOOL fSetAuto,
  [in, optional]  BSTR AutoPollUrl
);

Parameters

fSetAuto

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

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.

Return Value

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

Syntax

Sub SetAutoPollConfig( _
  ByVal fSetAuto As Boolean, _
  [ ByVal AutoPollUrl As String ] _
)

Parameters

fSetAuto

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

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

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

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

FPCBackupRoute


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.