Método IXpsOMPath::GetAccessibilityLongDescription (xpsobjectmodel.h)

Obtém a descrição textual longa (detalhada) do conteúdo do objeto. Essa descrição é usada por clientes de acessibilidade para descrever o objeto.

Sintaxe

HRESULT GetAccessibilityLongDescription(
  [out, retval] LPWSTR *longDescription
);

Parâmetros

[out, retval] longDescription

A descrição textual detalhada do conteúdo do objeto. Se esse texto não tiver sido definido, um ponteiro NULL será retornado.

Retornar valor

O método retorna um HRESULT. Os valores possíveis incluem, mas não se limitam a, aqueles na tabela a seguir. Para obter informações sobre valores retornados da API de documento XPS que não estão listados nesta tabela, consulte Erros de documento XPS.

Comentários

O valor retornado em longDescription é o valor do atributo AutomationProperties.HelpText do elemento Path na marcação do documento.

Esse método aloca a memória usada pela cadeia de caracteres retornada em longDescription. Se longDescription não for NULL, use a função CoTaskMemFree para liberar a memória.

Requisitos

Confira também

IXpsOMPath

Especificação de Papel XML

Erros de documento XPS