ISyncMgrHandlerInfo::GetTypeLabel-Methode (syncmgr.h)

Artikel
03/02/2024

Ruft eine Bezeichnung für den Handlertyp ab. Dies stellt in der Regel das Modell des Geräts oder eine entsprechende handlerspezifische Identitätszeichenfolge bereit.

Syntax

HRESULT GetTypeLabel(
  [out] LPWSTR *ppszTypeLabel
);

Parameter

[out] ppszTypeLabel

Typ: LPWSTR*

Wenn diese Methode zurückgibt, enthält einen Zeiger auf einen Puffer, der die Bezeichnungszeichenfolge enthält.

Rückgabewert

Typ: HRESULT

Gibt bei erfolgreicher Ausführung S_OK oder andernfalls einen Fehlerwert zurück. Wenn die Methode fehlschlägt, enthält ppszTypeLabel eine leere Zeichenfolge.

Hinweise

Der Bezeichnungswert wird in der Ordnerbenutzeroberfläche als System.Sync.HandlerTypeLabel-Eigenschaft (PKEY_Sync_HandlerTypeLabel) angezeigt. Sync Center ruft diese Methode immer dann auf, wenn die UpdateHandler-Methode aufgerufen wird.

Der Handler ist für die Zuweisung des Zeichenfolgenpuffers verantwortlich, auf den ppszTypeLabel über CoTaskMemAlloc verweist. Sync Center gibt die Zuordnung des Zeichenfolgenpuffers über CoTaskMemFree auf.

Beispiele

Das folgende Beispiel zeigt eine Implementierung dieser Methode.

STDMETHODIMP CMyDeviceHandler::GetTypeLabel(__out LPWSTR *ppszTypeLabel)
{
    LPWSTR pszTypeLabel = NULL;

    HRESULT hr = LoadStringAlloc(g_hmodThisDll, 
                                 IDS_HANDLER_TYPE_LABEL,
                                 &pszTypeLabel);
    if (SUCCEEDED(hr))
    {
        // Duplicate for the caller.
        hr = SHCoAllocString(pszTypeLabel, ppszTypeLabel);
        LocalFree(pszTypeLabel);
    }

    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