IEPGEpisode::Layout

[This is preliminary documentation and subject to change.]

The Layout method returns additional information about the episode's enhancement.

HRESULT Layout (
  long lEnhMappingID,
  BSTR * EnhTitle,
  BSTR * EnhLayout,
  BSTR * EnhAddress
);
 

Parameters

lEnhMappingID

Long that contains the enhancement mapping identifier. This corresponds to either the lTSEnhMappingID or lEpiEnhMappingID value returned by the IEPGEpisode::HasEnhancement method.

EnhTitle

Pointer to a string that receives the title of the interactive show.

EnhLayout

Pointer to a string that receives the starting or default HTML layout page for the enhancement.

EnhAddress

Pointer to a string that recieves the enhancement IP address. Triggers for the enhancement will be sent to this address.

Remarks

This method is only valid for episodes that have enhancements. To test whether an episode has enhancements, call IEPGEpisode::HasEnhancement.

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