ISyncMgrHandler::GetName-Methode (syncmgr.h)

  • Artikel

Ruft den Anzeigenamen des Handlers ab.

Syntax

HRESULT GetName(
  [out] LPWSTR *ppszName
);

Parameter

[out] ppszName

Typ: LPWSTR*

Wenn diese Methode zurückgibt, enthält einen Zeiger auf einen Puffer mit NULL-Beendigung, der den Handlernamen empfängt. Der Name kann eine maximale Länge MAX_SYNCMGR_NAME haben, einschließlich des endenden NULL-Zeichens . Wenn der Name diese Länge überschreitet, wird er abgeschnitten.

Rückgabewert

Typ: HRESULT

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

Hinweise

Auf den Handlernamen wird als System.DisplayName-Eigenschaft (PKEY_DisplayName) im Ordner Sync Center zugegriffen.

Das Synchronisierungscenter ruft diese Methode jedes Mal auf, wenn UpdateHandler oder UpdateHandlerCollection aufgerufen wird. Wenn ISyncMgrHandler::GetName fehlschlägt oder eine leere Zeichenfolge zurückgibt, wird der Handler nicht im Ordner Sync Center angezeigt, und das Synchronisierungscenter versucht nicht, ihn aufzurufen.

Es liegt in der Verantwortung des Handlers, den Zeichenfolgenpuffer mithilfe von CoTaskMemAlloc zuzuordnen. Sync Center gibt die Zuordnung des Puffers über CoTaskMemFree auf.

ISyncMgrHandler::GetName ersetzt die Verwendung von GetHandlerInfo zum Abrufen des Handlernamens.

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