getStateTextA 函数 (oleacc.h)

  • 项目

检索描述单个预定义状态位标志的对象状态的本地化字符串。 由于状态值是一个或多个位标志的组合，因此客户端多次调用此函数以检索所有状态字符串。

语法

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

parameters

[in] lStateBit

类型： DWORD

对象状态常量之一。

[out] lpszState

类型： LPTSTR

接收状态文本字符串的缓冲区的地址。 如果此参数为 NULL，则该函数将返回状态字符串的长度，不包括 null 字符。

[in] cchState

类型： UINT

lpszStateBit 参数指向的缓冲区的大小。 对于 ANSI 字符串，此值以字节为单位;对于 Unicode 字符串，它以字符为单位。

返回值

类型： UINT

如果成功，并且 lpszStateBit 为非 NULL，则返回值是 (ANSI 字符串) 字节数或复制到缓冲区 (Unicode 字符串) 的字符数，不包括以 null 结尾的字符。 如果 lpszStateBit 为 NULL，则返回值表示字符串的长度，不包括 null 字符。

如果字符串资源不存在，或者 lpszStateBit 参数不是有效的指针，则返回值为零， (0) 。 要获得更多的错误信息，请调用 GetLastError。

注解

此函数一次只接受一个状态位，而不是位掩码。

注意

oleacc.h 标头将 GetStateText 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。 有关详细信息，请参阅 函数原型的约定。

要求

   
最低受支持的客户端 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
目标平台 Windows
标头 oleacc.h
Library Oleacc.lib
DLL Oleacc.dll
可再发行组件 Windows NT 4.0（SP6 及更高版本）和 Windows 95 上的活动辅助功能 1.3 RDK