IEPGItem::PreviewGraphic

[This is preliminary documentation and subject to change.]

The PreviewGraphic method gets the file name of a graphic to display when the item is not currently being broadcast.

HRESULT PreviewGraphic (
  BSTR* pstrPreviewGraphic  
);
 

Parameters

pstrPreviewGraphic

Pointer to a BSTR that receives the file name. If no preview graphic exists, the method returns a NULL BSTR.

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

For example, a preview graphic could be displayed as a placeholder for live video from a channel that is currently off the air.

QuickInfo

  Windows NT: Unsupported.
  Windows: Requires Windows 98.
  Windows CE: Unsupported.
  Import Library: User-defined.
  Unicode: Yes.