Win32 API 日本語リファレンス
ホームSystem.AddressBook › IMAPIContainer

IMAPIContainer

COM
継承元IMAPIProp自前メソッド開始 vtbl14

公式ドキュメント

IMAPIContainerIMAPIProp は、アドレス帳、配布リスト、フォルダーなどのコンテナーオブジェクトに対する高レベルの操作を管理します。

解説(Remarks)

適用対象: Outlook 2013 | Outlook 2016

アドレス帳、配布リスト、フォルダーなどのコンテナーオブジェクトに対する高レベルの操作を管理します。IMAPIFolder : IMAPIContainerIABContainer : IMAPIContainerIDistList : IMAPIContainer の各インターフェースは IMAPIContainer から派生しています。

プロパティ
ヘッダーファイル:
Mapidefs.h
公開元:
フォルダー、アドレス帳コンテナー、配布リストの各オブジェクト
実装元:
メッセージストア、アドレス帳、リモートトランスポートの各プロバイダー
呼び出し元:
クライアントアプリケーション
インターフェース識別子:
IID_IMAPIContainer
ポインター型:
LPMAPICONTAINER
トランザクションモデル:
抽象クラス、実装されることはありません

メソッド 5

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

vtbl 14 HRESULT GetContentsTable(DWORD ulFlags, IMAPITable** lppTable)
ulFlagsDWORDinテーブル取得の動作を制御するフラグを指定する。
lppTableIMAPITable**outコンテナの内容を表すコンテンツテーブル IMAPITable を受け取るポインタである。
vtbl 15 HRESULT GetHierarchyTable(DWORD ulFlags, IMAPITable** lppTable)
ulFlagsDWORDinテーブル取得の動作を制御するフラグを指定する。
lppTableIMAPITable**outコンテナの階層を表す階層テーブル IMAPITable を受け取るポインタである。
vtbl 16 HRESULT OpenEntry(DWORD cbEntryID, ENTRYID* lpEntryID, GUID* lpInterface, DWORD ulFlags, DWORD* lpulObjType, IUnknown** lppUnk)
cbEntryIDDWORDinlpEntryID が指すエントリ ID のバイト数を指定する。
lpEntryIDENTRYID*in開くオブジェクトのエントリ ID へのポインタである。NULL でコンテナ自身を開く場合がある。
lpInterfaceGUID*inout開くオブジェクトに要求するインターフェイスの識別子 (IID) へのポインタである。
ulFlagsDWORDinオブジェクトを開く際の動作を制御するフラグを指定する。
lpulObjTypeDWORD*out開かれたオブジェクトの種別を受け取る変数へのポインタである。
lppUnkIUnknown**out開かれたオブジェクトのインターフェイス IUnknown を受け取るポインタである。
vtbl 17 HRESULT SetSearchCriteria(SRestriction* lpRestriction, SBinaryArray* lpContainerList, DWORD ulSearchFlags)
lpRestrictionSRestriction*inoptional検索コンテナに適用する検索条件を示す SRestriction へのポインタである。
lpContainerListSBinaryArray*inoptional検索対象とするコンテナのエントリ ID の配列 SBinaryArray へのポインタである。
ulSearchFlagsDWORDin検索の開始/停止や再帰の有無などを制御するフラグを指定する。
vtbl 18 HRESULT GetSearchCriteria(DWORD ulFlags, SRestriction** lppRestriction, SBinaryArray** lppContainerList, DWORD* lpulSearchState)
ulFlagsDWORDin検索条件取得の動作を制御するフラグを指定する。
lppRestrictionSRestriction**out現在の検索条件を示す SRestriction を受け取るポインタである。
lppContainerListSBinaryArray**out検索対象コンテナのエントリ ID 配列 SBinaryArray を受け取るポインタである。
lpulSearchStateDWORD*outoptional現在の検索の状態を受け取る変数へのポインタである。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)

HSP用 COM定義

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

出力引数:
#define global IID_IMAPIContainer "{}"
#usecom global IMAPIContainer IID_IMAPIContainer "{}"
#comfunc global IMAPIContainer_GetContentsTable   14 int,sptr
#comfunc global IMAPIContainer_GetHierarchyTable  15 int,sptr
#comfunc global IMAPIContainer_OpenEntry          16 int,var,var,int,var,sptr
#comfunc global IMAPIContainer_SetSearchCriteria  17 var,var,int
#comfunc global IMAPIContainer_GetSearchCriteria  18 int,var,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。