SetTaskPeriod Method of the IFPCScheduledContentDownloadConfig Interface

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