Função GetRoleTextA (oleacc.h)

Recupera a cadeia de caracteres localizada que descreve a função do objeto para o valor de função especificado.

Sintaxe

UINT GetRoleTextA(
  [in]  DWORD lRole,
  [out] LPSTR lpszRole,
  [in]  UINT  cchRoleMax
);

Parâmetros

[in] lRole

Tipo: DWORD

Uma das constantes de função de objeto .

[out] lpszRole

Tipo: LPTSTR

Endereço de um buffer que recebe a cadeia de caracteres de texto de função. Se esse parâmetro for NULL, a função retornará o comprimento da cadeia de caracteres de função, não incluindo o caractere nulo.

[in] cchRoleMax

Tipo: UINT

O tamanho do buffer apontado pelo parâmetro lpszRole . Para cadeias de caracteres ANSI, esse valor é medido em bytes; para cadeias de caracteres Unicode, ela é medida em caracteres.

Retornar valor

Tipo: UINT

Se tiver êxito e se lpszRole não for NULL, o valor retornado será o número de bytes (cadeias de caracteres ANSI) ou caracteres (cadeias de caracteres Unicode) copiados para o buffer, não incluindo o caractere nulo de terminação. Se lpszRole for NULL, o valor retornado representará o comprimento da cadeia de caracteres, sem incluir o caractere nulo.

Se o recurso de cadeia de caracteres não existir ou se o parâmetro lpszRole não for um ponteiro válido, o valor retornado será zero (0). Para obter informações de erro estendidas, chame GetLastError.

Comentários

Observação

O cabeçalho oleacc.h define GetRoleText como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	oleacc.h
Biblioteca	Oleacc.lib
DLL	Oleacc.dll
Redistribuível	Active Accessibility 1.3 RDK no Windows NT 4.0 com SP6 e posterior e Windows 95