Função GetStateTextA (oleacc.h)

Recupera uma cadeia de caracteres localizada que descreve o estado de um objeto para um único sinalizador de bit 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 retornado

Tipo: UINT

Se tiver êxito e se lpszStateBit 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, sem incluir o caractere terminado em nulo. Se lpszStateBit 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 lpszStateBit não for um ponteiro válido, o valor retornado será zero (0). Para obter informações de erro estendidas, chame GetLastError.

Comentários

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

Requisitos