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

Obtém um rótulo para o tipo de item. Normalmente, isso fornece o modelo do dispositivo ou uma cadeia de caracteres de identidade específica de item equivalente.

Sintaxe

HRESULT GetTypeLabel(
  [out] LPWSTR *ppszTypeLabel
);

Parâmetros

[out] ppszTypeLabel

Tipo: LPWSTR*

Quando esse método retorna, contém um ponteiro para um buffer que contém a cadeia de caracteres de rótulo.

Retornar valor

Tipo: HRESULT

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

Comentários

O valor do rótulo é exibido como a propriedade System.Sync.ItemTypeLabel (PKEY_Sync_ItemTypeLabel) na interface do usuário da pasta. A Central de Sincronização chama esse método sempre que o método UpdateHandler ou UpdateItem é chamado.

O item é responsável por alocar o buffer de cadeia de caracteres apontado por ppszTypeLabel por meio de CoTaskMemAlloc. A Central de Sincronização desaloca o buffer de cadeia de caracteres por meio de CoTaskMemFree.

Requisitos