IEPGItem::GetOption

[This is preliminary documentation and subject to change.]

The GetOption method retrieves the specified option, or command, from the item.

HRESULT GetOption (
  long iOptionNumber,  
  long* plID,          
  BSTR* pstrText       
);
 

Parameters

iOptionNumber

A long that specifies the zero-based identifier of the option to retrieve. This value cannot be greater than IEPGItem::NumOptions – 1.

plID

Pointer to a long that receives the interface identifier (IID) of the option specified by the iOptionNumber parameter.

pstrText

Pointer to a BSTR that receives the name of the command. This name is the same text as displayed on the option buttons in the Program Guide, such as Watch, Remind, or Other Times.

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::NumOptions, IEPGItem::OptionPrompt