IEPGEpisode::IsRemindItem

[This is preliminary documentation and subject to change.]

The IsRemindItem method returns a value indicating whether the episode is a remind item.

HRESULT IsRemindItem(
  VARIANT_BOOL * pf
);
 

Parameters

pf

Pointer to a variable that receives VARIANT_TRUE if a reminder is set for the episode, and VARIANT_FALSE otherwise.

Return Values

Returns an HRESULT indicating success or failure. If the method succeeds it returns S_OK. Otherwise it returns an error code. For specific error code values see Winerror.h.

Remarks

Remind items are set by WebTV for Windows. Some remind items, typically episodes that are for display purposes only, do not have a valid time slot associated with them — in other words, their TS Time Slot ID fields equal zero. If the time slot identifier is zero, but IsRemindItem returns S_OK, this indicates that a reminder is set but that there are no shows matching this reminder in the Program Guide.

QuickInfo

  Windows NT: Unsupported.
  Windows: Requires Windows 98.
  Windows CE: Unsupported.
  Import Library: User-defined.
  Unicode: Yes.

See Also

IEPGEpisode::IsRecordItem, IEPGEpisode::RemindRecordIdx, IEPGEpisode::Repetition