Поделиться через

Функция GetStateTextA (oleacc.h)

  • Статья

Извлекает локализованную строку, описывающую состояние объекта для одного предопределенного битового флага состояния. Так как значения состояния представляют собой сочетание одного или нескольких битовых флагов, клиенты вызывают эту функцию несколько раз, чтобы получить все строки состояния.

Синтаксис

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

Параметры

[in] lStateBit

Тип: DWORD

Одна из констант состояния объекта.

[out] lpszState

Тип: LPTSTR

Адрес буфера, получающего текстовую строку состояния. Если этот параметр имеет значение NULL, функция возвращает длину строки состояния, не включая символ NULL.

[in] cchState

Тип: UINT

Размер буфера, на который указывает параметр lpszStateBit . Для строк ANSI это значение измеряется в байтах; для строк Юникода он измеряется в символах.

Возвращаемое значение

Тип: UINT

В случае успешного выполнения и если значение lpszStateBit не равно NULL, возвращаемое значение — это количество байтов (строки ANSI) или символов (строки Юникода), которые копируются в буфер, не включая символ, заканчивающийся null. Если lpszStateBit имеет значение NULL, возвращаемое значение представляет длину строки, не включая символ NULL.

Если строковый ресурс не существует или параметр lpszStateBit не является допустимым указателем, возвращаемое значение равно нулю (0). Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Комментарии

Эта функция принимает только один бит состояния за раз, а не битовую маску.

Примечание

Заголовок oleacc.h определяет GetStateText в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

   
Минимальная версия клиента Windows 2000 Professional [только классические приложения]
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Целевая платформа Windows
Header oleacc.h
Библиотека Oleacc.lib
DLL Oleacc.dll
Распространяемые компоненты Активные специальные возможности 1.3 RDK в Windows NT 4.0 с пакетом обновления 6 (SP6) и более поздних версий и Windows 95