ISyncMgrSyncItem::GetName-Methode (syncmgr.h)

  • Artikel

Ruft den Anzeigenamen der Benutzeroberfläche des Synchronisierungselements ab.

Syntax

HRESULT GetName(
  [out] LPWSTR *ppszName
);

Parameter

[out] ppszName

Typ: LPWSTR*

Wenn diese Methode zurückgibt, enthält einen Zeiger auf einen Puffer, der den Anzeigenamen des Elements enthält. Diese Zeichenfolge hat eine maximale Länge MAX_SYNCMGR_NAME einschließlich des beendenden NULL-Zeichens . Längere Zeichenfolgen werden abgeschnitten.

Rückgabewert

Typ: HRESULT

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

Hinweise

Wenn GetName 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 auf der Ordnerbenutzeroberfläche des Handlers als System.DisplayName-Eigenschaft (PKEY_DisplayName) 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.

Sync Center ruft diese Methode immer dann auf, wenn die UpdateItem-Methode aufgerufen wird.

In älteren Sync Manager-Implementierungen wurden diese Informationen über die SYNCMGRHANDLERINFO-Struktur abgerufen.

Beispiele

Das folgende Beispiel zeigt eine Implementierung dieser Methode.

STDMETHODIMP CMyDeviceSyncItem::GetName(__out LPWSTR *ppszName)
{
    *ppszName = NULL;
    HRESULT hr = SHCoAllocString(_pszItemName, ppszName);
    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