Edit

Share via

IMFAttributes::GetStringLength method (mfobjects.h)

  • Article

Retrieves the length of a string value associated with a key.

Syntax

HRESULT GetStringLength(
  [in]  REFGUID guidKey,
  [out] UINT32  *pcchLength
);

Parameters

[in] guidKey

GUID that identifies which value to retrieve. The attribute type must be MF_ATTRIBUTE_STRING.

[out] pcchLength

If the key is found and the value is a string type, this parameter receives the number of characters in the string, not including the terminating NULL character. To get the string value, call IMFAttributes::GetString.

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.
MF_E_ATTRIBUTENOTFOUND
 The specified key was not found.
MF_E_INVALIDTYPE
 The attribute value is not a string.

Remarks

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

Requirement Value
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

MF_ATTRIBUTE_TYPE