Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

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 IContentDirectoryImplclass therefore overrides this method to return ERROR_AV_UPNP_INVALID_ACTION.

For more information about the actions in the ContentDirectory service, see UPnP AV DCP Documentation.

Requirements

Header av_upnp.h
Library Av_upnp.lib
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also