ISyncMgrSessionCreator::CreateSession-Methode (syncmgr.h)

Artikel
08/26/2023

Benachrichtigt das Synchronisierungscenter, dass die Synchronisierung der angegebenen Elemente begonnen hat.

Syntax

HRESULT CreateSession(
  [in] LPCWSTR              pszHandlerID,
  [in] LPCWSTR              *ppszItemIDs,
  [in] ULONG                cItems,
  [in] ISyncMgrSyncCallback **ppCallback
);

Parameter

[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 endenden NULL-Zeichens .

[in] ppszItemIDs

Typ: LPCWSTR*

Die Adresse eines Zeigers auf einen Puffer, der ein Array von Element-IDs enthält, die von dem in pszHandlerID angegebenen Handler verwaltet werden, der synchronisiert werden soll. Jede ID hat eine maximale Länge MAX_SYNCMGR_ID einschließlich des endenden NULL-Zeichens .

[in] cItems

Typ: ULONG

Die Anzahl der Element-IDs, die im Puffer enthalten sind, auf den in ppszItemIDs verwiesen wird.

[in] ppCallback

Typ: ISyncMgrSyncCallback**

Die Adresse eines Zeigers auf eine instance von ISyncMgrSyncCallback, die zum Melden von Status und Ereignissen verwendet wird. Dieser Wert kann NULL sein, wenn kein Rückruf erforderlich ist.

Rückgabewert

Typ: HRESULT

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

Hinweise

Sowohl pszHandlerID als auch ppszItemIDs müssen angegeben werden.

Beispiele

Das folgende Beispiel zeigt die Gliederung einer Implementierung dieser Methode.

STDMETHODIMP CMyDeviceHandler::Synchronize(...)
{
    ...
    ISyncMgrSyncCallback *pCallback = NULL;

    hr = pCreator->CreateSession(_pszHandlerID, ppszItemIDs, cItems, &pCallback);
    if (SUCCEEDED(hr))
    {
        // Perform synchronization.
    }

    return hr;
}

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