IFPCSchedule::IsSet method

Applies to: desktop apps only

The IsSet method returns a Boolean value that indicates whether every hour in the specified set is part of the schedule.

Syntax

HRESULT IsSet(
  [in]   FpcScheduleDays Day,
  [in]   FpcScheduleHours Hour,
  [out]  VARIANT_BOOL *pfIsSet
);
FPCSchedule.IsSet( _
  ByVal Day As FpcScheduleDays, _
  ByVal Hour As FpcScheduleHours, _
  ByRef pfIsSet As VARIANT_BOOL _
) As Boolean

Parameters

  • Day [in]
    Value from the FpcScheduleDays enumerated type that specifies a day or the entire week. It can be ALL_WEEK, SUN, MON, and so on.

  • Hour [in]
    Value from the FpcScheduleHours enumerated type that specifies an hour or hours. It can be ALL_DAY, AM_0, AM_1, PM_1, PM_2, and so on.

  • pfIsSet [out]
    Pointer to a Boolean variable that is set on return to VARIANT_TRUE if every hour in the set specified by the Day and Hour parameters is part of the schedule, or to VARIANT_FALSE if any hour in the set is not part of the schedule.

Return value

C++

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

VB

Boolean value that is set to True if every hour in the set specified by the Day and Hour parameters is part of the schedule, or to False if any hour in the set is not part of the schedule.

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 2_PM is the one-hour time block between 2:00 P.M. (14:00) and 3:00 P.M. (15:00).

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

Set

UnSet

 

 

Build date: 7/12/2010