Share via

IWMSCacheProxy.OnCacheClientClose (C#)

  • Article

banner art

Previous Next

IWMSCacheProxy.OnCacheClientClose (C#)

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

Syntax

Parameters

resultHr

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

pUserContext

[in] IWMSContext object containing the user context.

pPresentationContext

[in] IWMSContext object containing the presentation context.

Return Values

This method does not return a value. To report an error, the plug-in can throw a COMException object to the server. If the plug-in uses the IWMSEventLog object to log error information, it is recommended that it throw NS_E_PLUGIN_ERROR_REPORTED (0xC00D157D). 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 object to send custom error information to the Windows Event Viewer, throwing NS_E_PLUGIN_ERROR_REPORTED stops the server from also logging to the event viewer. For more information about 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

using Microsoft.WindowsMediaServices.Interop;

// Minimal implementation.
void IWMSCacheProxy.OnCacheClientClose( int resultHr , 
                                        IWMSContext pUserContext , 
                                        IWMSContext pPresentationContext )
{
  return;
}

Requirements

Reference: Add a reference to Microsoft.WindowsMediaServices.

Namespace: Microsoft.WindowsMediaServices.Interop.

Assembly: Microsoft.WindowsMediaServices.dll.

Library: WMSServerTypeLib.dll.

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

See Also

Previous Next