IWMSContentDescriptionList::GetDescriptionInLanguage

  • Article

banner art

Previous Next

IWMSContentDescriptionList::GetDescriptionInLanguage

The GetDescriptionInLanguage method retrieves the content description context for a specific language.

Syntax

  HRESULT GetDescriptionInLanguage(
  LPCWSTR  pstrLanguage,
  IWMSContext**  ppDescription
);

Parameters

pstrLanguage

[in] LPCWSTR specifying a national language. The values that can be specified for this parameter are the HTTP language tags defined in RFC 1766. For example, en-us identifies American English.

ppDescription

[out] Pointer to a pointer to an IWMSContext interface.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Return code Number Description
E_INVALIDARG 0x80070057 The pstrLanguage parameter or the ppDescription parameter is NULL.

Example Code

// Declare variables.
IWMSContext* pContentDescrCtx;

// Use a pointer to an IWMSContentDescriptionList interface to 
// retrieve the content description context.
hr = ContentDescriptionList->GetDescriptionInLanguage( 
                                    L"en-us", 
                                    &pContentDescrCtx );
if (FAILED(hr)) goto EXIT;

EXIT:
    // TODO: Release temporary objects.

Requirements

Header: streamdescription.h.

Library: WMSServerTypeLib.dll.

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

See Also

Previous Next