Win32 API 日本語リファレンス
ホーム › UI.Accessibility › IToggleProvider

IToggleProvider

COM
📘 Microsoft Learn (日本語) · English
IID56d00bd0-c4f4-433c-a836-1a52a57e0892継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

一連の状態を順に切り替え、設定された状態を保持できるコントロールへのアクセスを提供します。

解説(Remarks)

Toggle コントロールパターンをサポートする必要がある Microsoft UI Automation プロバイダーに実装されます。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT Toggle()

コントロールのトグル状態を順に切り替えます。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

コントロールは、その ToggleState を次の順序で順に切り替える必要があります。 ToggleState_On、ToggleState_Off、 そしてサポートされている場合は ToggleState_Indeterminate。

vtbl 4 HRESULT get_ToggleState(ToggleState* pRetVal)

コントロールのトグル状態を指定します。

pRetValToggleState*outオン・オフ・不確定のいずれかを示す ToggleState 値を受け取るポインタである。

解説(Remarks)

コントロールは、その ToggleState を次の順序で順に切り替える必要があります。
ToggleState_On、ToggleState_Off、 そしてサポートされている場合は ToggleState_Indeterminate。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IToggleProvider "{56D00BD0-C4F4-433C-A836-1A52A57E0892}"
#usecom global IToggleProvider IID_IToggleProvider "{}"
#comfunc global IToggleProvider_Toggle           3
#comfunc global IToggleProvider_get_ToggleState  4 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。