SetTaskPeriod Method of the IFPCScheduledContentDownloadConfig Interface

  • Article

The SetTaskPeriod method sets the values of the TaskPeriod property (the type of schedule) and the ScheduleDays property (the days of the week on which the content download job will run) of the content download job.

C++

Syntax

HRESULT SetTaskPeriod(
  [in]            FpcScheduledTaskRunningPeriod Period,
  [in, optional]  FpcDaysOfWeek Days
);

Parameters

  • Period
    Value from the FpcScheduledTaskRunningPeriod enumerated type that specifies whether the content download job will run only once, every day, or on specified days of the week.

  • Days
    Bitmask of the FpcDaysOfWeek enumerated type that specifies the days of the week on which the content download job will run. This parameter is used if the Period parameter is set to the fpcRunOnSpecifiedDaysOfWeek value of the FpcScheduledTaskRunningPeriod enumerated type. The default value is fpcNone.

Return Value

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

Visual Basic

Syntax

Sub SetTaskPeriod( _
  ByVal Period As FpcScheduledTaskRunningPeriod, _
  [ ByVal Days As FpcDaysOfWeek ] _
)

Parameters

  • Period
    Value from the FpcScheduledTaskRunningPeriod enumerated type that specifies whether the content download job will run only once, every day, or on specified days of the week.

  • Days
    Bitmask of the FpcDaysOfWeek enumerated type that specifies the days of the week on which the content download job will run. This parameter is used if the Period parameter is set to the fpcRunOnSpecifiedDaysOfWeek value of the FpcScheduledTaskRunningPeriod enumerated type. The default value is fpcNone.

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.

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

FPCScheduledContentDownloadConfig

Send comments about this topic to Microsoft

Build date: 6/30/2010