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

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

Sintaxe

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

Parâmetros

[out, retval] longDescription

A descrição textual longa (detalhada) do conteúdo do objeto. Um ponteiro NULL será retornado se esse texto não tiver sido definido.

Retornar valor

O método retorna um HRESULT. Os valores possíveis incluem, mas não se limitam, 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.

Código de retorno	Descrição
S_OK	O método foi bem-sucedido.
E_POINTER	longDescription é NULL.

Comentários

A propriedade retornada por esse método corresponde ao atributo AutomationProperties.HelpText do elemento Canvas 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 SignatureDefinitions para liberar a memória.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 7, Windows Vista com SP2 e Atualização de Plataforma para Windows Vista [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2008 R2, Windows Server 2008 com SP2 e Platform Update para Windows Server 2008 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	xpsobjectmodel.h

Confira também

IXpsOMCanvas

Especificação de Papel XML

Erros de documento XPS