Compartir a través de

Método ISyncMgrHandlerInfo::GetComment (syncmgr.h)

  • Artículo

Obtiene una cadena que contiene comentarios sobre el controlador.

Sintaxis

HRESULT GetComment(
  [out] LPWSTR *ppszComment
);

Parámetros

[out] ppszComment

Tipo: LPWSTR*

Cuando este método devuelve , contiene un puntero a un búfer que contiene la cadena de comentario. Esta cadena tiene una longitud máxima MAX_SYNCMGR_NAME, incluido el carácter nulo de terminación.

Valor devuelto

Tipo: HRESULT

Devuelve S_OK si se realiza correctamente; de lo contrario, un valor de error. Si se produce un error en el método, ppszComment contiene una cadena vacía.

Comentarios

Un controlador podría proporcionar esta cadena para mostrar un resumen del contenido de la asociación, por ejemplo, "32 contactos" o "13 canciones". La cadena puede tener una longitud máxima de MAX_SYNCMGR_NAME, incluido el carácter nulo de terminación.

El valor de comentario se muestra como la propiedad System.Sync.Comments (PKEY_Sync_Comments) en la interfaz de usuario de la carpeta cuando no se realiza una sincronización.

El Centro de sincronización llama a este método cada vez que se llama al método UpdateHandler .

El controlador es responsable de asignar el búfer de cadena al que apunta ppszComment a través de CoTaskMemAlloc. El Centro de sincronización desasigna el búfer de cadenas a través de CoTaskMemFree.

Requisitos

   
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