Share via

IContentDirectory::StopTransferResource

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method stops the specified transfer, which was initiated using IContentDirectory::ImportResource or IContentDirectory::ExportResource.

Syntax

virtual DWORD StopTransferResource(
  unsigned long TransferID
) = 0;

Parameters

  • TransferID
    [in] ID of the transfer to stop. Corresponds to the A_ARG_TYPE_TransferID 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_FILE_TRANSFER   

Remarks

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

The ContentDirectory service does not require that this method be implemented. 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 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

Reference

IContentDirectory
IContentDirectory::ExportResource
IContentDirectory::ImportResource
IContentDirectoryImpl
UPnPAVError