GetRoleTextA 函数 (oleacc.h)

检索描述指定角色值的对象的角色的本地化字符串。

语法

UINT GetRoleTextA(
  [in]  DWORD lRole,
  [out] LPSTR lpszRole,
  [in]  UINT  cchRoleMax
);

参数

[in] lRole

类型:DWORD

对象角色之一 常量。

[out] lpszRole

类型:LPTSTR

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

[in] cchRoleMax

类型:UINT

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

返回值

类型:UINT

如果成功,并且如果 lpszRole 为非NULL,则返回值是复制到缓冲区中的字节数(ANSI 字符串)或字符(Unicode 字符串),不包括终止 null 字符。 如果 lpszRoleNULL,则返回值表示字符串的长度,不包括 null 字符。

如果字符串资源不存在,或者 lpszRole 参数不是有效的指针,则返回值为零(0)。 若要获取扩展的错误信息,请调用 GetLastError

言论

注意

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

要求

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