IContentDirectory::DestroyObject (Compact 7)

  • Article

3/12/2014

This method deletes the specified object. If the object being deleted is a container, all of the container's children are also deleted. Any references to deleted objects are also deleted.

Syntax

virtual DWORD DestroyObject(
  LPCWSTR pszObjectID
) = 0;

Parameters

  • pszObjectID
    [in] ID of the object to be deleted. Corresponds to the A_ARG_TYPE_ObjectID state variable.

Return Value

Custom implementations can return appropriate error codes. Should return SUCCESS_AV if the method succeeds. Otherwise, should return an error code defined in WinError.h or UPnP.h, or one of the UPnP AV-specific return values specified in UPnPAVError, especially the following errors documented for this action in the ContentDirectory DCP documentation:

  • ERROR_AV_UPNP_ACTION_FAILED
  • ERROR_AV_UPNP_CD_NO_SUCH_OBJECT
  • ERROR_AV_UPNP_CD_RESTRICTED_OBJECT
  • ERROR_AV_UPNP_CD_RESTRICTED_PARENT_OBJECT
  • ERROR_AV_UPNP_CD_SOURCE_RESOURCE_ACCESS_DENIED

Remarks

This method corresponds to the ContentDirectory service's DestroyObject action.

The ContentDirectory service does not require that this method be implemented. Therefore, the IContentDirectoryImpl class therefore overrides this method to return ERROR_AV_UPNP_INVALID_ACTION.

For more information about the actions in the ContentDirectory service, see UPnP Forum AV Web site.

Requirements

Header

av_upnp.h

Library

Av_upnp.lib

See Also

Reference

IContentDirectory
IContentDirectoryImpl
UPnPAVError