ITVViewer::HasReminder

[This is preliminary documentation and subject to change.]

The HasReminder method returns a value specifying whether a reminder is set for the specified episode.

HRESULT HasReminder(
  IUnknown *pEpisode,  
  VARIANT_BOOL bRecord 
  VARIANT_BOOL *bReminder 
);
 

Parameters

pEpisode

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

bRecord

Boolean value that indicates the type of reminder to look for. This can be one of the following values.

Value	Meaning
VARIANT_TRUE	A reminder to record the show.
VARIANT_FALSE	A reminder to watch the show.

bReminder

Pointer to a boolean variable that receives the reminder information. This can be one of the following values.

Value	Meaning
VARIANT_TRUE	A reminder is set for the episode.
VARIANT_FALSE	No reminder is set for the episode.

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::HasEnhancement, IEPGEpisode