IFPCSchedule::Set method

Applies to: desktop apps only

The Set method adds a set of hours to the schedule.

Syntax

HRESULT Set(
  [in]  FpcScheduleDays Day,
  [in]  FpcScheduleHours Hour
);
FPCSchedule.Set( _
  ByVal Day As FpcScheduleDays, _
  ByVal Hour As FpcScheduleHours _
)

Parameters

  • Day [in]
    Value from the FpcScheduleDays enumerated type that specifies a day or the entire week. The possible values are fpcALL_WEEK, fpcSUN, fpcMON, and so on.

  • Hour [in]
    Value from the FpcScheduleHours enumerated type that specifies an hour or hours. The possible values are fpcALL_DAY, fpcAM_0, fpcAM_1, fpcPM_1, fpcPM_2, and so on.

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

The hour blocks defined by a schedule include the specified time and the one-hour block following that time. For example, the hour designated by fpc2_PM is the one-hour time block between 2:00 P.M. (14:00) and 3:00 P.M. (15:00).

Examples

The following line adds "3 A.M. on Sunday" to the schedule:

mySchedule.Set fpcSUN, fpcAM_3

The following line adds "6 A.M. on every day" to the schedule:

mySchedule.Set fpcALL_WEEK, fpcAM_6

The following line adds all of Monday to the schedule:

mySchedule.Set fpcMON, fpcALL_DAY

The following line adds all hours of the week to the schedule:

mySchedule.Set fpcALL_WEEK, fpcALL_DAY

For a C++ code example that shows how to create a new schedule and to use this method to configure the new schedule to apply to all hours on all days, see Adding a Schedule Using C++.

For a Visual Basic code example that shows how to create a new schedule and to use this method to configure the new schedule to apply to all hours on all days, see Adding a Schedule Using Visual Basic.

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

FPCSchedule

IsSet

UnSet

 

 

Build date: 7/12/2010