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 字元。 如果 lpszRole 為 NULL,則傳回值代表字串的長度,不包括 Null 字元。
如果字串資源不存在,或 lpszRole 參數不是有效的指標,則傳回值會是零 (0) 。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
備註
注意
oleacc.h 標頭會將 GetRoleText 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows 2000 專業版 [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | oleacc.h |
程式庫 | Oleacc.lib |
Dll | Oleacc.dll |
可轉散發套件 | Windows NT 4.0 上的 Active Accessibility 1.3 RDK 與 SP6 和更新版本和 Windows 95 |