次の方法で共有


GetRoleTextA 関数 (oleacc.h)

指定したロール値のオブジェクトのロールを記述するローカライズされた文字列を取得します。

構文

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

パラメーター

[in] lRole

種類: DWORD

オブジェクト ロール定数の 1 つ。

[out] lpszRole

種類: LPTSTR

ロール テキスト文字列を受け取るバッファーのアドレス。 このパラメーターが NULL の場合、この関数は null 文字を含まないロール文字列の長さを返します。

[in] cchRoleMax

型: UINT

lpszRole パラメーターによって指されるバッファーのサイズ。 ANSI 文字列の場合、この値はバイト単位で測定されます。Unicode 文字列の場合は、文字で測定されます。

戻り値

型: UINT

成功した場合、 lpszRoleNULL 以外の場合、戻り値はバッファーにコピーされたバイト数 (ANSI 文字列) または文字 (Unicode 文字列) であり、終端の null 文字は含まれません。 lpszRoleNULL の場合、戻り値は null 文字を含まない文字列の長さを表します。

文字列リソースが存在しない場合、または lpszRole パラメーターが有効なポインターでない場合、戻り値はゼロ (0) になります。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

注意

oleacc.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetRoleText を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー oleacc.h
Library Oleacc.lib
[DLL] Oleacc.dll
再頒布可能パッケージ SP6 以降および Windows 95 を使用した Windows NT 4.0 の Active Accessibility 1.3 RDK