Share via

IWMSCacheProxyServerCallback::OnDownloadContentFinished

  • Article

banner art

Previous Next

IWMSCacheProxyServerCallback::OnDownloadContentFinished

The OnDownloadContentFinished method is called by the server to respond when a cache plug-in calls IWMSCacheProxyServer::DownloadContent. The OnDownloadContentFinished method is called when the content has been completely downloaded. If the requested content is a server-side playlist, this method is called only after all of the playlist entries have been downloaded. The IWMSCacheProxyServerCallback::OnDownloadContentProgress method is called every time a playlist entry has been downloaded.

Syntax

  HRESULT OnDownloadContentFinished(
  
  HRESULT
  
  hr
  ,
  
  SAFEARRAY(Variant)
    psaArchiveContexts
  ,
  
  VARIANT
  
  varContext
  
  );

Parameters

hr

[in] HRESULT indicating whether the call to IWMSCacheProxyServer::DownloadContent succeeded.

psaArchiveContexts

[in] Pointer to a SAFEARRAY containing one or more archive contexts. When a single on-demand file is downloaded, the array will contain one context. When multiple items in a playlist are downloaded, the array will contain a context for each item, and the first entry will contain an archive context describing the entire playlist.

varContext

[in] VARIANT containing a value defined by the plug-in when it called IWMSCacheProxyServer::DownloadContent. For example, your plug-in can use this parameter to persist state information. The server does not alter this value and passes it back when calling OnDownloadContentFinished.

Return Values

If the method succeeds, the plug-in must return S_OK. To report an error, the plug-in can return any HRESULT other than S_OK. If the plug-in uses the IWMSEventLog interface to log error information directly to the Windows Event Viewer, it is recommended that it return NS_E_PLUGIN_ERROR_REPORTED. Typically, the server attempts to make plug-in error information available to the server object model, the Windows Event Viewer, and the troubleshooting list in the details pane of the Windows Media Services MMC. However, if the plug-in uses the IWMSEventLog interface to send custom error information to the Windows Event Viewer, returning NS_E_PLUGIN_ERROR_REPORTED stops the server from also logging to the event viewer. For more information about retrieving plug-in error information, see Identifying Plug-in Errors.

Example Code

Requirements

Header: streamcache.h.

Library: WMSServerTypeLib.dll.

Platform: Windows Server 2003, Enterprise Edition; Windows Server 2003, Datacenter Edition; Windows Server 2008.

See Also

Previous Next