IMFShutdown::GetShutdownStatus method

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

Syntax


HRESULT GetShutdownStatus(
  [out]  MFSHUTDOWN_STATUS *pStatus
);

Parameters

pStatus [out]

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 codeDescription
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

Minimum supported client

Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Header

Mfidl.h

Library

Mfuuid.lib

See also

IMFShutdown

 

 

Community Additions

ADD
Show:
© 2014 Microsoft