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

Obtiene el nombre para mostrar del controlador.

Sintaxis

HRESULT GetName(
  [out] LPWSTR *ppszName
);

Parámetros

[out] ppszName

Tipo: LPWSTR*

Cuando este método devuelve , contiene un puntero a un búfer terminado en null que recibe el nombre del controlador. El nombre puede ser de longitud máxima MAX_SYNCMGR_NAME, incluido el carácter nulo de terminación. Si el nombre supera esa longitud, se trunca.

Valor devuelto

Tipo: HRESULT

Si este método se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

Comentarios

Se tiene acceso al nombre del controlador como la propiedad System.DisplayName (PKEY_DisplayName) en la carpeta Centro de sincronización.

El Centro de sincronización llama a este método cada vez que se llama a UpdateHandler o UpdateHandlerCollection . Si se produce un error en ISyncMgrHandler::GetName o devuelve una cadena vacía, el controlador no se muestra en la carpeta Centro de sincronización y el Centro de sincronización no intentará invocarlo.

Es responsabilidad del controlador asignar el búfer de cadenas mediante CoTaskMemAlloc. El Centro de sincronización desasigna el búfer a través de CoTaskMemFree.

ISyncMgrHandler::GetName reemplaza el uso de GetHandlerInfo para recuperar el nombre del controlador.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	syncmgr.h