IMFAsyncResult::GetObject Method

Returns an object associated with the asynchronous operation. The type of object, if any, depends on the asynchronous method that was called.

Syntax

public:
HRESULT GetObject(
         IUnknown **ppObject
)

Parameters

ppObject
Type: IUnknown **

[out, optional]

Receives a pointer to the object’s IUnknown interface. If no object is associated with the operation, this parameter receives the value NULL. If the value is not NULL, the caller must release the interface.

Return value

Type: HRESULT

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

Return codes

Return code	Description
S_OK	The method succeeded.
E_POINTER	There is no object associated with this asynchronous result.

Refer to Media Foundation return codes.

Remarks

Typically, this object is used by the component that implements the asynchronous method. It provides a way for the function that invokes the callback to pass information to the asynchronous End... method that completes the operation.

If you are implementing an asynchronous method, you can set the object through the punkObject parameter of the MFCreateAsyncResult function.

If the asynchronous result object’s internal IUnknown pointer is NULL, the method returns E_POINTER.

Requirements

Header: Declared in mfobjects.h (include mfidl.h).

Library: Use Mfuuid.lib.