Fungsi GetStateTextA (oleacc.h)

Mengambil string yang dilokalkan yang menjelaskan status objek untuk satu bendera bit status yang telah ditentukan sebelumnya. Karena nilai status adalah kombinasi dari satu atau beberapa bendera bit, klien memanggil fungsi ini lebih dari sekali untuk mengambil semua string status.

Sintaks

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

Parameter

[in] lStateBit

Jenis: DWORD

Salah satu konstanta status objek.

[out] lpszState

Jenis: LPTSTR

Alamat buffer yang menerima string teks status. Jika parameter ini NULL, fungsi mengembalikan panjang string status, tidak termasuk karakter null.

[in] cchState

Jenis: UINT

Ukuran buffer yang diarahkan oleh parameter lpszStateBit . Untuk string ANSI, nilai ini diukur dalam byte; untuk string Unicode, string diukur dalam karakter.

Mengembalikan nilai

Jenis: UINT

Jika berhasil, dan jika lpszStateBitbukan-NULL, nilai yang dikembalikan adalah jumlah byte (string ANSI) atau karakter (string Unicode) yang disalin ke dalam buffer, tidak termasuk karakter yang dihentikan null. Jika lpszStateBit adalah NULL, nilai yang dikembalikan mewakili panjang string, tidak termasuk karakter null.

Jika sumber daya string tidak ada, atau jika parameter lpszStateBit bukan penunjuk yang valid, nilai yang dikembalikan adalah nol (0). Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Fungsi ini hanya menerima satu bit status pada satu waktu, bukan bitmask.

Catatan

Header oleacc.h mendefinisikan GetStateText sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta pra-prosesor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	oleacc.h
Pustaka	Oleacc.lib
DLL	Oleacc.dll
Redistribusi	Aksesibilitas Aktif 1.3 RDK di Windows NT 4.0 dengan SP6 dan yang lebih baru dan Windows 95