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

Статья
11/20/2024

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

Синтаксис

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. Если lpszStateBitNULL, возвращаемое значение представляет длину строки, а не значение NULL.

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

Замечания

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

Заметка

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

Требования

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

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