Compartilhar via

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

  • Artigo

Obtém um rótulo para o tipo de manipulador. Normalmente, isso fornece o modelo do dispositivo ou uma cadeia de caracteres de identidade específica do manipulador 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.HandlerTypeLabel (PKEY_Sync_HandlerTypeLabel) na interface do usuário da pasta. O Sync Center chama esse método sempre que o método UpdateHandler é chamado.

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

Exemplos

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

STDMETHODIMP CMyDeviceHandler::GetTypeLabel(__out LPWSTR *ppszTypeLabel)
{
    LPWSTR pszTypeLabel = NULL;

    HRESULT hr = LoadStringAlloc(g_hmodThisDll, 
                                 IDS_HANDLER_TYPE_LABEL,
                                 &pszTypeLabel);
    if (SUCCEEDED(hr))
    {
        // Duplicate for the caller.
        hr = SHCoAllocString(pszTypeLabel, ppszTypeLabel);
        LocalFree(pszTypeLabel);
    }

    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