ITVViewer::SetReminder

[This is preliminary documentation and subject to change.]

The SetReminder method sets a reminder for the specified episode. The reminder is set as a task in the Task Scheduler.

HRESULT SetReminder(
  IUnknown *pEpisode,  
  VARIANT_BOOL bRecord 
);
 

Parameters

pEpisode

Pointer to an IEPGEpisode interface. Your application must implement an episode object that supports IEPGEpisode. Your application initializes the object's properties with data that reflects the episode to schedule.

bRecord

Boolean value that specifies whether the reminder should be a record reminder. This can be one of the following values.

Value	Meaning
VARIANT_TRUE	Set a reminder to record a broadcast.
VARIANT_FALSE	Set a reminder to watch a broadcast.

Remarks

If the reminder is a record reminder, you should use the Task Scheduler to set the TASK_FLAG_SYSTEM_REQUIRED flag for the reminder. This causes WebTV for Windows to tune to the channel even if the system is sleeping. Otherwise, if the system is sleeping, WebTV for Windows will not wake up to run the record reminder.

In addition, if the record reminder has an application associated with it that automates tuning the VCR this application should be specified in the StartRecordingApp and/or EndRecordingApp values under this registry key:

HKLM\Software\Microsoft\TV Services\Explorer\

The TASK_FLAG_SYSTEM_REQUIRED flag should not be set for standard show reminders. Version 1.0 of Broadcast Architecture does not handle show reminders that go off while the system is sleeping.

For more information see Setting a Show Reminder and Setting a Record Reminder.

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.

QuickInfo

  Windows NT: Unsupported.
  Windows: Requires Windows 98.
  Windows CE: Unsupported.
  Header: Declared in tvdisp.odl.
  Import Library: Included as a resource in tvx.exe.
  Unicode: Yes.

See Also

ITVViewer::DeleteReminder, Setting a Show Reminder, Setting a Record Reminder.