Fungsi GetRoleTextW (oleacc.h)

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

Sintaksis

UINT GetRoleTextW(
  [in]  DWORD  lRole,
  [out] LPWSTR lpszRole,
  [in]  UINT   cchRoleMax
);

Parameter

[in] lRole

Jenis: DWORD

Salah satu peran objek konstanta.

[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 ditunjukkan 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 lpszRole non-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 null, nilai pengembalian 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, panggil GetLastError.

Komentar

Persyaratan