IEPGItem::BodyText

[This is preliminary documentation and subject to change.]

The BodyText method gets the description of the item. Typically, the description text retrieved by BodyText is the as stored in the Guide database.

HRESULT BodyText (
  BSTR* pstrBodyText  
);
 

Parameters

pstrBodyText
Pointer to a BSTR that receives the item description.

Remarks

The subject of the description depends on the object implementating IEPGItem. For example, in an episode object, one that implements IEPGEpisode, the BodyText method retreives a description of the episode.

Typically, the description text for an episode object is the same text stored in the Guide database. For an object that correponds to an episode in the Guide database, the description text is stored in the E Description field of the Episode table.

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

IEPGItem::Title