Share via

IWMSDataContainerVersion::GetEntityTag

  • Article

banner art

Previous Next

IWMSDataContainerVersion::GetEntityTag

The GetEntityTag method retrieves an entity tag, given an index number.

Syntax

  HRESULT GetEntityTag(
  DWORD  dwTagNum,
  BSTR*  pszEntityTag
);

Parameters

dwTagNum

[in] DWORD containing the tag number.

pszEntityTag

[out] Pointer to a BSTR containing the entity tag.

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

You can specify any string as an entity tag. Entity tags provide an additional way to differentiate between types of content.

Example Code

// Use a pointer to an IWMSDataContainerVersion interface to 
// retrieve the number of entity tags.
HRESULT hr = pVersion->GetEntityTagCount( (long *) &dwNumTags );

// Retrieve each tag.
for( dw = 0; i < dwNumTags; dw++ )
{
    CComBSTR bstrTag;

    hr = pVersion->GetEntityTag( dw, &bstrTag );

    // TODO: Use the tag.
}

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