Função GetStateTextA (oleacc.h)

Artigo
11/20/2024

Recupera uma cadeia de caracteres localizada que descreve o estado de um objeto para um único sinalizador de bits de estado predefinido. Como os valores de estado são uma combinação de um ou mais sinalizadores de bits, os clientes chamam essa função mais de uma vez para recuperar todas as cadeias de caracteres de estado.

Sintaxe

UINT GetStateTextA(
  [in]  DWORD lStateBit,
  [out] LPSTR lpszState,
  [in]  UINT  cchState
);

Parâmetros

[in] lStateBit

Tipo: DWORD

Uma das constantes de estado do objeto .

[out] lpszState

Tipo: LPTSTR

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

[in] cchState

Tipo: UINT

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

Valor de retorno

Tipo: UINT

Se tiver êxito e se lpszStateBit não forNULL, 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 encerrado em nulo. Se lpszStateBit for NULL, o valor retornado representará o comprimento da cadeia de caracteres, não incluindo o caractere nulo.

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

Observações

Essa função aceita apenas um bit de estado por vez, não uma máscara de bits.

Nota

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

Requisitos

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

Compartilhar via