ISyncMgrControl::EnableItem-Methode (syncmgr.h)

Artikel
03/04/2024

Aktiviert oder deaktiviert ein Synchronisierungselement, das von einem angegebenen Handler verwaltet wird.

Syntax

HRESULT EnableItem(
  [in] BOOL                  fEnable,
  [in] LPCWSTR               pszHandlerID,
  [in] LPCWSTR               pszItemID,
  [in] HWND                  hwndOwner,
  [in] SYNCMGR_CONTROL_FLAGS nControlFlags
);

Parameter

[in] fEnable

Typ: BOOL

TRUE , um zu aktivieren; Zu deaktivierende FALSE .

[in] pszHandlerID

Typ: LPCWSTR

Ein Zeiger auf einen Puffer, der die eindeutige ID des Handlers enthält. Diese Zeichenfolge hat eine maximale Länge MAX_SYNCMGR_ID einschließlich des beendenden NULL-Zeichens .

[in] pszItemID

Typ: LPCWSTR

Ein Zeiger auf einen Puffer, der die eindeutige ID des Elements enthält. Diese Zeichenfolge hat eine maximale Länge MAX_SYNCMGR_ID einschließlich des beendenden NULL-Zeichens .

[in] hwndOwner

Typ: HWND

Ein Handle für ein Fenster, das vom Element verwendet werden kann, um eine beliebige erforderliche Benutzeroberfläche anzuzeigen. Dieser Wert kann NULL sein.

[in] nControlFlags

Typ: SYNCMGR_CONTROL_FLAGS

Ein Wert aus der SYNCMGR_CONTROL_FLAGS Enumeration, die angibt, ob das Aktivieren oder Deaktivieren des Elements synchron oder asynchron ausgeführt werden soll.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Ein aktiviertes Element ist ein Element, das synchronisiert werden kann.

Wenn das angegebene Element SYNCMGR_ICM_QUERY_BEFORE_ENABLE oder SYNCMGR_ICM_QUERY_BEFORE_DISABLE in der von der GetCapabilities-Methode zurückgegebenen Maske zurückgibt, wird dem Benutzer ein Bestätigungsdialogfeld angezeigt, das angefordert wird, bevor das Element aktiviert oder deaktiviert wird. Wenn keine Abfrage-Benutzeroberfläche angefordert wird oder der Benutzer den Vorgang bestätigt, wird die Enable-Methode des Elements aufgerufen.

Wenn SYNCMGR_CF_WAIT im nControlFlags-Parameter festgelegt ist, wird EnableItem erst zurückgegeben, wenn das Sync Center diese Benachrichtigung verarbeitet hat.

Beispiele

Das folgende Beispiel zeigt die Verwendung von ISyncMgrControl::EnableHandler durch die Prozedur eines Handlers.

void MiscProc(...)
{
    ...

    // Get the Sync Center control object.
    ISyncMgrControl *pControl = NULL;
    
    hr = CoCreateInstance(CLSID_SyncMgrControl, 
                          CLSCTX_SERVER, 
                          IID_PPV_ARGS(&pControl));
    if (SUCCEEDED(hr))
    {
        // Tell Sync Center to disable the item.
        hr = pControl->EnableItem(FALSE, 
                                  s_szMySyncHandlerID,
                                  s_szMySyncHandlerMusicContentID, 
                                  hwnd,
                                  SYNCMGR_CF_WAIT);
        pControl->Release();
    }

    ...

}

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	syncmgr.h

Freigeben über