IContentDirectory::GetTransferProgress (Compact 7)

3/12/2014

This method returns status information about a resource transfer initiated using IContentDirectory::ImportResource or IContentDirectory::ExportResource.

Syntax

virtual DWORD GetTransferProgress(
  unsigned long TransferID,
  wstring* pstrTransferStatus,
  wstring* pstrTransferLength,
  wstring* pstrTransferTotal
) = 0;

Parameters

• TransferID
  [in] ID of the transfer to query for status information. Corresponds to the A_ARG_TYPE_TransferID state variable.

• pstrTransferStatus
  [in, out] Pointer to a string that contains the current status of transfer. Can be one of IN_PROGRESS, STOPPED, ERROR, or COMPLETED. The ContentDirectory instance should maintain status for completed transfers for at least 30 seconds. Corresponds to the A_ARG_TYPE_TransferStatus state variable.

• pstrTransferLength
  [in, out] Pointer to a string that contains the number of bytes that have been transferred. Corresponds to the A_ARG_TYPE_TransferLength state variable.

• pstrTransferTotal
  [in, out] Pointer to a string that contains the total number of bytes to be transferred in this transfer operation. Corresponds to the A_ARG_TYPE_TransferTotal 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 GetTransferProgress 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 Forum AV Web site.

Requirements

See Also

Reference

IContentDirectory
IContentDirectory::ExportResource
IContentDirectory::ImportResource
IContentDirectoryImpl
UPnPAVError