IWMPFolderMonitorServices::get_scanState method (wmp.h)

Article
4/26/2023

[The feature associated with this page, Windows Media Player SDK, is a legacy feature. It has been superseded by MediaPlayer. MediaPlayer has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer instead of Windows Media Player SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

This method and all other methods of the IWMPFolderMonitorServices interface are deprecated.

The get_scanState method retrieves the scan state for the current scanning operation.

Syntax

HRESULT get_scanState(
  [out] WMPFolderScanState *pwmpfss
);

Parameters

[out] pwmpfss

Pointer to a variable that receives a value from the WMPFolderScanState enumeration that indicates the scan state.

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.

Remarks

A scanning operation consists of two phases: scanning and updating. During the first phase, Windows Media Player determines which digital media files to add to the library. During the second phase, the Player adds the files. You can handle the FolderScanStateChange event to receive notifications when the scan state changes.

Windows Media Player 10 Mobile: This method is not supported.

Requirements

Requirement	Value
Minimum supported client	Windows Media Player 11.
Target Platform	Windows
Header	wmp.h
DLL	Wmp.dll

Share via