Edit

Share via

IMFShutdown::GetShutdownStatus method (mfidl.h)

  • Article

Queries the status of an earlier call to the IMFShutdown::Shutdown method.

Syntax

HRESULT GetShutdownStatus(
  [out] MFSHUTDOWN_STATUS *pStatus
);

Parameters

[out] pStatus

Receives a member of the MFSHUTDOWN_STATUS enumeration.

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_INVALIDARG
 Invalid argument.
MF_E_INVALIDREQUEST
 The Shutdown method has not been called on this object.

Remarks

Until Shutdown is called, the GetShutdownStatus method returns MF_E_INVALIDREQUEST.

If an object's Shutdown method is asynchronous, pStatus might receive the value MFSHUTDOWN_INITIATED. When the object is completely shut down, pStatus receives the value MFSHUTDOWN_COMPLETED.

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 mfidl.h
Library Mfuuid.lib

See also

IMFShutdown