ISyncMgrControl::StartItemSync-Methode (syncmgr.h)

Artikel
08/26/2023

Initiiert die Synchronisierung der angegebenen Elemente, die von einem bestimmten Handler verwaltet werden.

Syntax

HRESULT StartItemSync(
  [in] LPCWSTR                    pszHandlerID,
  [in] LPCWSTR                    *ppszItemIDs,
  [in] ULONG                      cItems,
  [in] HWND                       hwndOwner,
  [in] IUnknown                   *punk,
  [in] SYNCMGR_SYNC_CONTROL_FLAGS nSyncControlFlags,
  [in] ISyncMgrSyncResult         *pResult
);

Parameter

[in] pszHandlerID

Typ: LPCWSTR

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

[in] ppszItemIDs

Typ: LPCWSTR*

Die Adresse eines Zeigers auf einen Puffer, der ein Array von IDs der zu synchronisierenden Elemente enthält. Jede ID hat eine maximale Länge MAX_SYNCMGR_ID einschließlich des endenden NULL-Zeichens . Dieses Array wird an Synchronize übergeben.

[in] cItems

Art: DWORD

Die Anzahl der IDs in ppszItemIDs.

[in] hwndOwner

Typ: HWND

Ein Handle für das Fenster, das das Element verwenden kann, um jede erforderliche Benutzeroberfläche anzuzeigen. Dieser Wert kann NULL sein.

[in] punk

Typ: IUnknown*

Ein Zeiger auf ein IUnknown,das an Synchronize übergeben werden soll. Dieser Parameter kann NULL sein.

[in] nSyncControlFlags

Typ: SYNCMGR_SYNC_CONTROL_FLAGS

Ein Member der SYNCMGR_SYNC_CONTROL_FLAGS-Enumeration , der angibt, ob ein Element, das sowohl in einer aktuellen Synchronisierung als auch in einer Warteschlange gefunden wurde, erneut synchronisiert werden soll, wenn die Synchronisierung in die Warteschlange ausgeführt wird.

[in] pResult

Typ: ISyncMgrSyncResult*

Ein Zeiger auf eine instance von ISyncMgrSyncResult, dessen Result-Methode aufgerufen wird, wenn die Synchronisierung beendet wird, entweder durch Erfolg, Fehler oder Abbruch. Die Result-Methode wird mit dem aggregierten Zustand der Handlersynchronisierung aufgerufen. Dieser Parameter kann NULL sein.

Rückgabewert

Typ: HRESULT

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

Hinweise

Diese Methode ist analog zu UpdateItems.

Beispiele

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

void CMyDeviceHandler::MiscProc(...)
{
    ...

    // Get the Sync Center control object.
    ISyncMgrControl *pControl = NULL;
    
    hr = CoCreateInstance(CLSID_SyncMgrControl, 
                          CLSCTX_SERVER,
                          IID_PPV_ARGS(&pControl));
    if (SUCCEEDED(hr))
    {
        // Synchronize one sync item for the sync handler.
        hr = pControl->StartItemSync(s_szMySyncHandlerID,
                                     s_szMySyncHandlerMusicContentID,
                                     1,
                                     _hwnd,
                                     NULL,
                                     NULL);
        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