ITVViewer::DeleteReminder

[This is preliminary documentation and subject to change.]

The DeleteReminder method deletes either a record reminder or all reminders for the specified episode, or for recurring episodes.

HRESULT DeleteReminder(
  IUnknown *pEpisode,  
  VARIANT_BOOL bRecord 
);
 

Parameters

pEpisode

Pointer to the IEPGEpisode interface for the episode.

bRecord

Boolean value that specifies whether to delete a record reminder or all reminders for the specified episode. This parameter can be one of the following values.

Value	Meaning
VARIANT_TRUE	Delete the record reminder. Each episode can have only one record reminder set.
VARIANT_FALSE	Delete all reminders. In other words, delete the record reminder and the regular 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.

Remarks

If the user has set a reminder for a weekly television broadcast this method deletes all of the reminders. If overlapping reminders exist, this method deletes only the first reminder for the specified episode.

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::SetReminder