IsSet Method of the IFPCSchedule Interface

[C++]

Syntax

HRESULT IsSet(
  [in]   FpcScheduleDays Day,
  [in]   FpcScheduleHours Hour,
  [out]  VARIANT_BOOL* pfIsSet
);

Parameters

Day

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

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

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

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

[Visual Basic]

Syntax

Function IsSet( _
  ByVal Day As FpcScheduleDays, _
  ByVal Hour As FpcScheduleHours _
) As Boolean

Parameters

Day

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

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.

Return Value

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.