ITelevisionServices::DeleteEnhancementFromID

[This is preliminary documentation and subject to change.]

The DeleteEnhancementFromID method deletes the specified enhancement record from the Guide database. This method does not delete the enhancement files associated with the specified record.

HRESULT DeleteEnhancementFromID(
  Workspace *piDAOWorkspace, 
  BSTR bstrEnhancementID
);
 

Parameters

piDAOWorkspace
Pointer to a DAO workspace. This workspace can be either preexisting or newly created.
bstrEnhancementID
GUID for the enhancement.

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 codes, see the Winerror.h and Dbdaoerr.h header files. To locate more information about Winerror.h and Dbdaoerr.h, see Further Information on Television Services for the Client.

Remarks

In order to use the DeleteEnhancementFromID method to remove enhancement data from the Guide database, you must know the GUID of the enhancement. Typically, DeleteEnhancementFromID is only called by the application that originally loaded the enhancement data.

For example, a broadcast content provider might send a deletion announcement that causes the enhancement filter to remove enhancement data from the Guide database. In this case, a list of that provider's enhancement identifiers is maintained at the head end and the appropriate identifier is sent with the deletion announcement.

It is not necessary to use DeleteEnhancementFromID to delete obsolete enhancement data from the database. This deletion is done periodically by Loadstub. To enable automatic deletion of enhancement data, your application must set an expiration date and time for the enhancement data at the time that it loads the data into the Guide database.

QuickInfo

  Windows NT: Unsupported.
  Windows: Requires Windows 98.
  Windows CE: Unsupported.
  Header: Declared in tssadmin.odl.
  Import Library: Included as a resource in tssadmin.dll.
  Unicode: Yes.

See Also

ITelevisionServices::DeleteOldEnhancements, ITelevisionServices::LoadEnhancement, ITelevisionServices::LoadEnhancementsFromFile, ITelevisionServices::RemapEnhancements