Share via

IWMSDataContainer::GetContainerFormat

  • Article

banner art

Previous Next

IWMSDataContainer::GetContainerFormat

The server calls the GetContainerFormat method to retrieve a GUID that identifies the format of the data container.

Syntax

  HRESULT GetContainerFormat(
  GUID*  pFormat
);

Parameters

pFormat

[out] Pointer to a GUID indicating the format.

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

If the plug-in cannot identify the format, it must return IID_IWMSUnknownFormat. For example, an NTFS data source plug-in does not need to understand the data format. If you are implementing a plug-in that enables the server to access playlist files, you can return IID_IWMSPlaylistSmilFormat. The only other valid GUID that can be returned is IID_IWMSDirectoryFormat.

Example Code

HRESULT STDMETHODCALLTYPE 
CDataContainer::GetContainerFormat( GUID *pFormat )
{
    HRESULT hr = S_OK;
    *pFormat = IID_IWMSPlaylistSmilFormat;
    return( hr );
}

Requirements

Header: datacontainer.h.

Library: WMSServerTypeLib.dll.

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

See Also

Previous Next