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

IDeskBand

COM
📘 Microsoft Learn (日本語) · English
IIDeb0fe172-1a3a-11d0-89b3-00a0c90a90ac継承元IDockingWindow自前メソッド開始 vtbl8

公式ドキュメント

バンドオブジェクトに関する情報を取得するために使用します。

解説(Remarks)

このインターフェイスは、継承元である IOleWindow および IDockingWindow インターフェイスのメソッドも提供します。

実装するタイミング

バンドオブジェクトを実装する場合は、IDeskBand を実装します。

使用するタイミング

このインターフェイスを直接呼び出すことはありません。IDeskBand は、シェルまたはブラウザーがバンドオブジェクトの表示情報を取得するために使用します。

メソッド 1

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

vtbl 8 HRESULT GetBandInfo(DWORD dwBandID, DWORD dwViewMode, DESKBANDINFO* pdbi)

バンドオブジェクトの状態情報を取得します。

dwBandIDDWORDinコンテナーによって割り当てられた、バンドの識別子です。必要に応じて、バンドオブジェクトはこの値を保持できます。
dwViewModeDWORDin

バンドオブジェクトのビューモードです。次のいずれかの値です。

DBIF_VIEWMODE_NORMAL

バンドオブジェクトが水平バンドで表示されています。

DBIF_VIEWMODE_VERTICAL

バンドオブジェクトが垂直バンドで表示されています。

DBIF_VIEWMODE_FLOATING

バンドオブジェクトがフローティングバンドで表示されています。

DBIF_VIEWMODE_TRANSPARENT

バンドオブジェクトが透過バンドで表示されています。

pdbiDESKBANDINFO*inoutオブジェクトのバンド情報を受け取る DESKBANDINFO 構造体へのポインターです。この構造体の dwMask メンバーは、要求される具体的な情報を示します。

戻り値

型: HRESULT

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IDeskBand "{EB0FE172-1A3A-11D0-89B3-00A0C90A90AC}"
#usecom global IDeskBand IID_IDeskBand "{}"
#comfunc global IDeskBand_GetBandInfo  8 int,int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。