Método IXpsOMCanvas::GetAccessibilityShortDescription (xpsobjectmodel.h)
Obtém uma breve descrição textual do conteúdo do objeto. Esse texto é usado por clientes de acessibilidade para descrever o objeto.
Sintaxe
HRESULT GetAccessibilityShortDescription(
[out, retval] LPWSTR *shortDescription
);
Parâmetros
[out, retval] shortDescription
A breve descrição textual do conteúdo do objeto. Se essa descrição não estiver definida, 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.
| Código de retorno | Descrição |
|---|---|
|
O método foi bem-sucedido. |
|
shortDescription é NULL. |
Comentários
A propriedade retornada por esse método corresponde ao atributo AutomationProperties.Name do elemento Canvas na marcação do documento.
Esse método aloca a memória usada pela cadeia de caracteres retornada em shortDescription. Se shortDescription não for NULL, use a função CoTaskMemFree para liberar a memória.
Requisitos
| 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 Atualização de Plataforma para Windows Server 2008 [aplicativos da área de trabalho | Aplicativos UWP] |
| Plataforma de Destino | Windows |
| Cabeçalho | xpsobjectmodel.h |