Método ISyncMgrHandler::GetName (syncmgr.h)

Obtém o nome de exibição do manipulador.

Sintaxe

HRESULT GetName(
  [out] LPWSTR *ppszName
);

Parâmetros

[out] ppszName

Tipo: LPWSTR*

Quando esse método retorna, contém um ponteiro para um buffer encerrado em nulo que recebe o nome do manipulador. O nome pode ter o comprimento máximo MAX_SYNCMGR_NAME, incluindo o caractere nulo de terminação. Se o nome exceder esse comprimento, ele será truncado.

Retornar valor

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

O nome do manipulador é acessado como a propriedade System.DisplayName (PKEY_DisplayName) na pasta Central de Sincronização.

A Central de Sincronização chama esse método sempre que UpdateHandler ou UpdateHandlerCollection é chamado. Se ISyncMgrHandler::GetName falhar ou retornar uma cadeia de caracteres vazia, o manipulador não será mostrado na pasta Central de Sincronização e o Centro de Sincronização não tentará invocá-lo.

É responsabilidade do manipulador alocar o buffer de cadeia de caracteres usando CoTaskMemAlloc. A Central de Sincronização desaloca o buffer por meio de CoTaskMemFree.

ISyncMgrHandler::GetName substitui o uso de GetHandlerInfo para recuperar o nome do manipulador.

Requisitos