IMFAsyncResult::GetState method (mfobjects.h)

Article
02/22/2024

Returns the state object specified by the caller in the asynchronous Begin method.

Syntax

HRESULT GetState(
  [out] IUnknown **ppunkState
);

Parameters

[out] ppunkState

Receives a pointer to the state object's IUnknown interface. If the value is not NULL, the caller must release the interface.

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.
E_POINTER	There is no state object associated with this asynchronous result.

Remarks

The caller of the asynchronous method specifies the state object, and can use it for any caller-defined purpose. The state object can be NULL. If the state object is NULL, GetState returns E_POINTER.

If you are implementing an asynchronous method, set the state object on the through the punkState parameter of the MFCreateAsyncResult function.

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