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 字串，此值是以位元組為單位來測量;若為 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
程式庫	Oleacc.lib
Dll	Oleacc.dll
可轉散發套件	Windows NT 4.0 和更新版本和 Windows 95 上的 Active Accessibility 1.3 RDK