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

Obtém uma cadeia de caracteres que contém comentários sobre o item.

Sintaxe

HRESULT GetComment(
  [out] LPWSTR *ppszComment
);

Parâmetros

[out] ppszComment

Tipo: LPWSTR*

Quando esse método retorna, contém um ponteiro para um buffer que contém a cadeia de caracteres de comentário. Essa cadeia de caracteres tem comprimento máximo MAX_SYNCMGR_NAME incluindo o caractere nulo de terminação.

Retornar valor

Tipo: HRESULT

Retorna S_OK se tiver êxito; caso contrário, um valor de erro. Se o método falhar, ppszComment conterá uma cadeia de caracteres vazia.

Comentários

Essa cadeia de caracteres pode ser fornecida por um item para exibir um resumo de seu conteúdo, por exemplo, "32 contatos" ou "13 músicas". A cadeia de caracteres pode ter um comprimento máximo de MAX_SYNCMGR_NAME incluindo o caractere nulo de terminação.

O valor do comentário é exibido como a propriedade System.Sync.Comments (PKEY_Sync_Comments) na interface do usuário da pasta quando uma sincronização não está sendo executada.

O Sync Center chama esse método sempre que o método UpdateHandler é chamado.

O item é responsável por alocar o buffer de cadeia de caracteres apontado por ppszComment por meio de CoTaskMemAlloc. O Sync Center desaloca o buffer de cadeia de caracteres por meio de CoTaskMemFree.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	syncmgr.h