次の方法で共有


GetStateTextA 関数 (oleacc.h)

1 つの定義済み状態ビット フラグのオブジェクトの状態を記述するローカライズされた文字列を取得します。 状態値は 1 つ以上のビット フラグの組み合わせであるため、クライアントはこの関数を複数回呼び出してすべての状態文字列を取得します。

構文

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

パラメーター

[in] lStateBit

型: DWORD

オブジェクト状態定数の 1 つ。

[out] lpszState

型: LPTSTR

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

[in] cchState

型: UINT

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

戻り値

型: UINT

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

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

備考

この関数は、ビットマスクではなく、一度に 1 つの状態ビットのみを受け入れます。

手記

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

必要条件

要件 価値
サポートされる最小クライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされる最小サーバー Windows Server 2003 [デスクトップ アプリのみ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー oleacc.h
ライブラリ Oleacc.lib
DLL Oleacc.dll
再頒布可能パッケージの Windows NT 4.0 SP6 以降および Windows 95 の Active Accessibility 1.3 RDK