MFGetAttributeUINT32

Returns a UINT32 value from an attribute store, or a default value if the attribute is not present.

Syntax

UINT32 MFGetAttributeUINT32(
         IMFAttributes *pAttributes,
         REFGUID guidKey,
         UINT32 unDefault
)  

Parameters

pAttributes
Type: IMFAttributes *

Pointer to the IMFAttributes interface of the attribute store.

guidKey
Type: REFGUID 

GUID that identifies which value to retrieve.

unDefault
Type: UINT32 

Default value to return if the attribute store does not contain the specified attribute.

Return value

Type: UINT32 

Returns a UINT32 value.

Return codes
Return code Description

Refer to Media Foundation return codes.

Remarks

This helper function queries the attribute store for the UINT32 value specified by guidKey. If the value is not present or does not have type UINT32, the function returns unDefault.

This function is convenient because it never returns a failure code. However, if the attribute in question does not have a meaningful default value, you should call IMFAttributes::GetUINT32 and check for MF_E_ATTRIBUTENOTFOUND.

Requirements

Header: Declared in mfapi.h.