Share via

Add Method of the IFPCScheduledContentDownload Interface

  • Article

The Add method creates a new FPCScheduledContentDownloadConfig object in the collection and returns a reference to it.

C++

Syntax

HRESULT Add(
  [in]   BSTR Name,
  [in]   BSTR URL,
  [out]  IFPCScheduledContentDownloadConfig** ppNewScheduledContentDownloadConfig
);

Parameters

  • Name
    Required. BSTR that specifies the name of the content download job.

  • URL
    Required. BSTR that specifies the URL from which content is to be fetched.

  • ppNewScheduledContentDownloadConfig
    Address of an interface pointer that on return points to the new IFPCScheduledContentDownloadConfig interface created.

Return Value

This method can return one of the following:

  • S_OK, indicating that the operation succeeded.
  • An error code, indicating that the operation failed. In this case, the [out] parameter returned is a null object.

Visual Basic

Syntax

Function Add( _
  ByVal Name As String, _
  ByVal URL As String _
) As FPCScheduledContentDownloadConfig

Parameters

  • Name
    Required. String that specifies the name of the new content download job.
  • URL
    Required. String that specifies the URL from which content is to be fetched.

Return Value

This method returns a reference to an FPCScheduledContentDownloadConfig object if successful. Otherwise, an error is raised that can be intercepted by using an error handler.

Remarks

The content download job created can run only if:

  • The Local Host network is configured to listen for requests from Web proxy clients (see the EnableWebProxyClients property of the FPCNetwork object representing the Local Host network).
  • There is a Web listener (an FPCWebListener object) that listens for requests from the Local Host network.
  • The Scheduled Download Jobs system policy configuration group is enabled (see the Enabled property of the FPCSystemPolicyConfigGroup object), or an access rule that allows HTTP traffic to the All Networks network set from the Local Host network is enabled.
  • The Microsoft Firewall service and the Microsoft Forefront TMG Job Scheduler service are running (see the FirewallServiceStatus and JobSchedulerServiceStatus properties of the applicable FPCServer object).
  • The Web proxy is enabled (see the Enabled property of the FPCApplicationFilter object representing the Web Proxy Filter add-in).

In addition, downloaded content can be stored in the Forefront TMG cache only if a cache drive with a size (CacheLimitInMegs) greater than zero is configured.

Requirements

Client Requires Windows 7 or Windows Vista.
Server Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version Requires Forefront Threat Management Gateway (TMG) 2010.
IDL

Declared in Msfpccom.idl.
DLL

Requires Msfpccom.dll.

See Also

FPCScheduledContentDownload

Send comments about this topic to Microsoft

Build date: 6/30/2010