| UID | title | description | helpviewer_keywords | old-location | tech.root | ms.assetid | ms.date | ms.keywords | req.header | req.include-header | req.target-type | req.target-min-winverclnt | req.target-min-winversvr | req.kmdf-ver | req.umdf-ver | req.ddi-compliance | req.unicode-ansi | req.idl | req.max-support | req.namespace | req.assembly | req.type-library | req.lib | req.dll | req.irql | targetos | req.typenames | req.redist | ms.custom | f1_keywords | dev_langs | topic_type | api_type | api_location | api_name | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NF:syncmgr.ISyncMgrHandlerInfo.IsEnabled |
ISyncMgrHandlerInfo::IsEnabled (syncmgr.h) |
Gets a value that indicates whether the handler is enabled. |
|
shell\ISyncMgrHandlerInfo_IsEnabled.htm |
shell |
1485ae25-20b8-4ee9-a30d-247f719047cd |
12/05/2018 |
ISyncMgrHandlerInfo interface [Windows Shell],IsEnabled method, ISyncMgrHandlerInfo.IsEnabled, ISyncMgrHandlerInfo::IsEnabled, IsEnabled, IsEnabled method [Windows Shell], IsEnabled method [Windows Shell],ISyncMgrHandlerInfo interface, _shell_ISyncMgrHandlerInfo_IsEnabled, shell.ISyncMgrHandlerInfo_IsEnabled, syncmgr/ISyncMgrHandlerInfo::IsEnabled |
syncmgr.h |
Windows |
Windows Vista [desktop apps only] |
Windows Server 2008 [desktop apps only] |
Syncmgr.idl |
Windows |
19H1 |
|
|
|
|
|
|
Gets a value that indicates whether the handler is enabled.
Type: HRESULT
Returns S_OK if the handler is enabled; otherwise, S_FALSE.
If the handler wants Sync Center to maintain the current state, it can return E_NOTIMPL. If any other value is returned, Sync Center sets the handler's enabled state to the last known value and enables or disables the associated tasks as appropriate.
If either the SYNCMGR_HCM_QUERY_BEFORE_ENABLE or SYNCMGR_HCM_QUERY_BEFORE_DISABLE flag is set in the mask returned from GetCapabilities, the handler must manage its own enabled state and therefore must return either S_OK or S_FALSE. Any other return value will be considered an error.
If a handler is disabled, neither it nor any of its items will be synchronized by Sync Center. Also, many of the possible actions available to a handler—such as Sync—are removed or disabled in the Sync Center folder UI.
This value is available in the folder UI as the System.Sync.Enabled (PKEY_Sync_Enabled) property.
Sync Center calls this method whenever the UpdateHandler method is called.
The following example shows an implementation of this method that calls a private class function to retrieve the enabled state.
STDMETHODIMP CMyDeviceHandler::IsEnabled()
{
// Return a previously-calculated value.
return (_fIsEnabled ? S_OK : S_FALSE);
}