IEPGItem::GetIcon

[This is preliminary documentation and subject to change.]

The GetIcon method retrieves the file name of the specified icon associated with the item.

HRESULT GetIcon (
  long iIconNumber,  
  BSTR* pstrIconName 
);
 

Parameters

iIconNumber

Zero-based identifier of the icon. This value cannot be greater than the value returned by the IEPGItem::NumIcons method – 1.

pstrIconName

Pointer to a BSTR that receives the file name of the icon identified by the iIconNumber parameter.

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

Icons of the type retrieved by GetIcon represent additional information about the broadcast, such as its rating and pay-per-view status and whether it has closed captioning.

QuickInfo

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

See Also

IEPGItem::NumIcons