ISyncMgrSyncItem::GetItemID-Methode (syncmgr.h)

Artikel
03/02/2024

Ruft die eindeutige ID eines Synchronisierungselements ab.

Syntax

HRESULT GetItemID(
  [out] LPWSTR *ppszItemID
);

Parameter

[out] ppszItemID

Typ: LPWSTR*

Wenn diese Methode zurückgibt, enthält einen Zeiger auf einen Puffer, der die ID des Elements enthält. Diese Zeichenfolge hat eine maximale Länge MAX_SYNCMGR_ID einschließlich des beendenden NULL-Zeichens .

Rückgabewert

Typ: HRESULT

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

Hinweise

Die von dieser Methode abgerufene ID kann nicht geändert werden. In der Regel ist die ID in Form einer GUID-Zeichenfolge. Dies ist jedoch keine Voraussetzung. Die ID kann eine beliebige Zeichenfolge sein, die im Kontext des Handlers eindeutig ist.

Wenn GetItemID fehlschlägt oder eine leere Zeichenfolge in ppszItemID zurückgegeben wird, wird das Synchronisierungselement nicht im Ordner des Handlers angezeigt, und sync Center versucht nicht, es zu synchronisieren.

Die von dieser Methode abgerufene ID ist in der Ordnerbenutzeroberfläche als System.Sync.ItemID -Eigenschaft (PKEY_Sync_HandlerID) verfügbar.

Das Element ist für die Zuordnung des Zeichenfolgenpuffers verantwortlich, auf den von ppszComment über CoTaskMemAlloc verwiesen wird. Sync Center ordnet den Zeichenfolgenpuffer über CoTaskMemFree zu.

In älteren Sync Manager-Implementierungen wurden diese Daten über die SYNCMGRITEM-Struktur abgerufen.

Beispiele

Das folgende Beispiel zeigt eine Implementierung dieser Methode.

STDMETHODIMP CMyDeviceSyncItem::GetItemID(__out LPWSTR *ppszItemID)
{
    HRESULT hr = S_OK;
    *ppszName = NULL;

    // Generate the string version of the ID.
    if (_pszItemID == NULL)
    {
        LPOLESTR pszItemID = NULL;
        hr = StringFromCLSID(_guidItemID, &_pszItemID);
    }

    if (SUCCEEDED(hr))
    {
        // Duplicate the item ID string for the caller.
        hr = SHCoAllocString(_pszItemID, ppszItemID);
    } 

    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