Fungsi GetRoleTextA (oleacc.h)

Mengambil string yang dilokalkan yang menjelaskan peran objek untuk nilai peran yang ditentukan.

Sintaks

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

Parameter

[in] lRole

Jenis: DWORD

Salah satu konstanta peran objek .

[out] lpszRole

Jenis: LPTSTR

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

[in] cchRoleMax

Jenis: UINT

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

Mengembalikan nilai

Jenis: UINT

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

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

Keterangan

Catatan

Header oleacc.h mendefinisikan GetRoleText 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

Persyaratan	Nilai
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