IWMSCacheProxy::OnCacheClientClose

  • Article

banner art

Previous Next

IWMSCacheProxy::OnCacheClientClose

The OnCacheClientClose method is called by the server to indicate that a client has finished streaming content.

Syntax

  HRESULT (
  
  HRESULT
  
  hr
  ,
  IWMSContext*  
  pUserContext
  ,
  
  IWMSContext*
  
  pPresentationContext
  
  );

Parameters

hr

[in] HRESULT indicating why the client finished playing content. If the client finished successfully, this parameter will be S_OK. If the client was not successful, the server passes an HRESULT error code.

pUserContext

[in] Pointer to an IWMSContext interface containing the user context.

pPresentationContext

[in] Pointer to an IWMSContext interface containing the presentation context.

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.

Remarks

The cache proxy plug-in can implement this method for a variety of reasons. For example, it can be used to collect statistics about the content being played, or it can be used to determine whether the requested content is played enough times to justify downloading it.

Example Code

HRESULT STDMETHODCALLTYPE 
CCachePlugin::OnCacheClientClose( 
                        HRESULT resultHr,
                        IWMSContext *pUserContext,
                        IWMSContext *pPresentationContext
                        )
{
    // TODO: Determine what action to take, if any, when the 
    // client has finished streaming.

    // Minimum implementation returns S_OK.
    return( S_OK );
}

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