IMFAttributes::SetString method

Associates a wide-character string with a key.

Syntax

HRESULT SetString(
  REFGUID guidKey,
  LPCWSTR wszValue
);

Parameters

guidKey

GUID that identifies the value to set. If this key already exists, the method overwrites the old value.

wszValue

Null-terminated wide-character string to associate with this key. The method stores a copy of the string.

Return Value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
The method succeeded.

Remarks

To retrieve the string, call IMFAttributes::GetString or IMFAttributes::GetAllocatedString.

This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:

  • Windows XP with Service Pack 2 (SP2) and later.
  • Windows XP Media Center Edition 2005 with KB900325 (Windows XP Media Center Edition 2005) and KB925766 (October 2006 Update Rollup for Windows XP Media Center Edition) installed.

Requirements

   
Minimum supported client Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header mfobjects.h (include Mfidl.h)
Library Mfuuid.lib

See Also

Attributes and Properties

IMFAttributes