IContentDirectory::ImportResource (Compact 7)

3/12/2014

This method starts the transfer of a file from a remote source to a local destination, using HTTP. To transfer a file from a local source to a remote destination, use IContentDirectory::ExportResource.

Note

This method is used to import media to a ContentDirectory instance, not to transfer media from a MediaServer instance to a MediaRenderer instance.

Syntax

virtual DWORD ImportResource(
  LPCWSTR pszSourceURI,
  LPCWSTR pszDestinationURI,
  unsigned long* pTransferID
) = 0;

Parameters

  • pszSourceURI
    [in] HTTP URI that specifies the location of the source resource. Corresponds to the A_ARG_TYPE_URI state variable.
  • pszDestinationURI
    [in] HTTP URI that specifies the end location of the resource. Corresponds to the A_ARG_TYPE_URI state variable.
  • pTransferID
    [in, out] Pointer to an integer allocated by the caller which this method modifies to contain a unique ID that identifies the transfer. This ID can be used with IContentDirectory::GetTransferProgress to monitor the progress of the transfer. 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_RESTRICTED_PARENT_OBJECT
  • ERROR_AV_UPNP_CD_NO_SUCH_SOURCE_RESOURCE
  • ERROR_AV_UPNP_CD_SOURCE_RESOURCE_ACCESS_DENIED
  • ERROR_AV_UPNP_CD_TRANSFER_BUSY
  • ERROR_AV_UPNP_CD_NO_SUCH_DESTINATION_RESOURCE
  • ERROR_AV_UPNP_CD_DESTINATION_RESOURCE_ACCESS_DENIED
  • ERROR_AV_UPNP_CD_REQUEST_FAILED

Remarks

This method corresponds to the ContentDirectory service's ImportResource 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, and about how resource transfer works in detail, see UPnP Forum AV Web site.

Requirements

Header

av_upnp.h

Library

Av_upnp.lib

See Also

Reference

IContentDirectory
IContentDirectory::GetTransferProgress
IContentDirectory::ExportResource
IContentDirectoryImpl
UPnPAVError