IEPGEpisode::HasEnhancement

[This is preliminary documentation and subject to change.]

The HasEnhancement method gets a value indicating whether the episode has enhancements. If the episode has enhancements, this method retrieves identifiers specifying the enhancement.

HRESULT HasEnhancement(
  VARIANT_BOOL *pf, 
  long * lTSEnhMappingID,
  long * lEpiEnhMappingID
);
 

Parameters

pf

Pointer to a boolean value that receives VARIANT_TRUE if the episode has enhancements, or VARIANT_FALSE otherwise.

lTSEnhMappingID

Pointer to a long that receives the time slot enhancement mapping identifier. This value is only set if the episode has enhancements.

lEpiEnhMappingID

Pointer to a long that receives the episode enhancement mapping identifier. This value is only set if the episode has enhancements.

Remarks

You can pass in NULL for either or both of the enhancement identifiers. In this case, HasEnhancement will still return a value that indicates whether the episode has enhancements, however it does not get values for the identifiers. The following code is an example of this usage:

pEPGEpisode->HasEnhancement(&fHasEnh, NULL, NULL) 
 

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.
  Import Library: User-defined.
  Unicode: Yes.

See Also

IEPGEpisode::Layout