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

Obtém o nome de exibição da interface do usuário do item de sincronização.

Sintaxe

HRESULT GetName(
  [out] LPWSTR *ppszName
);

Parâmetros

[out] ppszName

Tipo: LPWSTR*

Quando esse método retorna, contém um ponteiro para um buffer que contém o nome de exibição do item. Essa cadeia de caracteres tem comprimento máximo MAX_SYNCMGR_NAME incluindo o caractere nulo de terminação. Cadeias de caracteres mais longas são truncadas.

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

Se GetName falhar ou uma cadeia de caracteres vazia for retornada em ppszItemID, o item de sincronização não será mostrado na pasta do manipulador e o Centro de Sincronização não tentará sincronizá-lo.

A ID recuperada por esse método está disponível na interface do usuário da pasta do manipulador como a propriedade System.DisplayName (PKEY_DisplayName).

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.

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

Em implementações mais antigas do Gerenciador de Sincronização, essas informações foram recuperadas por meio da estrutura SYNCMGRHANDLERINFO .

Exemplos

O exemplo a seguir mostra uma implementação desse método.

STDMETHODIMP CMyDeviceSyncItem::GetName(__out LPWSTR *ppszName)
{
    *ppszName = NULL;
    HRESULT hr = SHCoAllocString(_pszItemName, ppszName);
    return hr;
}

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