IWMSContentDescriptionList::RemoveValueFromAllDescriptions

  • Article

banner art

Previous Next

IWMSContentDescriptionList::RemoveValueFromAllDescriptions

The RemoveValueFromAllDescriptions method removes a specific property from all the content description contexts in the description list.

Syntax

  HRESULT RemoveValueFromAllDescriptions(
  LPCWSTR  pstrName,
  long  lNameHint,
  long  dwOptions
);

Parameters

pstrName

[in] LPCWSTR specifying the name portion of the name-value pair in the context to be removed.

lNameHint

[in] long containing an optional key that can be used to more efficiently access the value.

dwOptions

[in] Reserved for future use.

Return Values

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

Return code Number Description
DISP_E_BADINDEX 0x8002000B The specified property could not be found.

Example Code

if (NULL != pPresentationContext)
{
    hr = pPresentationContext->RemoveValue( 
                           WMS_PRESENT_REDIRECT_LOCATION,
                           WMS_PRESENT_REDIRECT_LOCATION_ID,
                           0 );
    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