IWMSDataContainerVersion::GetCacheFlags

  • Article

banner art

Previous Next

IWMSDataContainerVersion::GetCacheFlags

The GetCacheFlags method retrieves flags that indicate whether content can be cached, proxied, or split.

Syntax

  HRESULT GetCacheFlags(
  long*  lFlags
);

Parameters

lFlags

[out] Pointer to a long containing flags that indicate download options. This must be a bitwise OR of one or more of the following WMS_DATA_CONTAINER_VERSION_CACHE_FLAGS values.

Value Description
WMS_DATA_CONTAINER_VERSION_ALLOW_PROXY_CACHING Proxy servers are permitted to cache the content.
WMS_DATA_CONTAINER_VERSION_ALLOW_PLAYER_CACHING Players are permitted to cache the content.
WMS_DATA_CONTAINER_VERSION_ALLOW_STREAM_SPLITTING The content can be split. Splitting a stream means that the proxy server makes a copy for each connected client.

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

// You can use this method to help specify a cache-miss policy.
hr = pContentVersion->GetCacheFlags( (long *) &dwCacheFlags );

if( dwCacheFlags & WMS_DATA_CONTAINER_VERSION_ALLOW_STREAM_SPLITTING )
{
    // If stream splitting is allowed, you can send the stream
    // as a broadcast.
    CacheMissPolicy = WMS_CACHE_QUERY_MISS_PLAY_BROADCAST;
}

Requirements

Header: datacontainerversion.h.

Library: WMSServerTypeLib.dll.

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

See Also

Previous Next