IOleUIObjInfoA

COM

継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

コンテナーによって実装され、コンテナーのオブジェクトのプロパティダイアログボックスおよび変換ダイアログボックスで使用されます。(ANSI)

解説(Remarks)

メモ

oledlg.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして IOleUIObjInfo を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

メソッド 5

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

vtbl 3 HRESULT GetObjectInfo(DWORD dwObject, DWORD* lpdwObjSize, LPSTR* lplpszLabel, LPSTR* lplpszType, LPSTR* lplpszShortType, LPSTR* lplpszLocation)

オブジェクトのサイズ、種類、名前、および場所の情報を取得します。(ANSI)

dwObject	DWORD	in	オブジェクトの一意の識別子です。
lpdwObjSize	DWORD*	out	ディスク上のオブジェクトのサイズ(バイト単位)へのポインターです。これは概算値である場合があります。
lplpszLabel	LPSTR*	outoptional	オブジェクトのラベル文字列へのポインターを受け取るポインター変数のアドレスです。このパラメーターを NULL にすると、実装がラベル文字列を返さないことを示します。
lplpszType	LPSTR*	outoptional	オブジェクトの長い種類文字列へのポインターを受け取るポインター変数のアドレスです。このパラメーターを NULL にすると、実装が長い種類文字列を返さないことを示します。
lplpszShortType	LPSTR*	outoptional	オブジェクトの短い種類文字列へのポインターを受け取るポインター変数のアドレスです。このパラメーターを NULL にすると、実装が短い種類文字列を返さないことを示します。
lplpszLocation	LPSTR*	outoptional	オブジェクトのソースの場所文字列へのポインターを受け取るポインター変数のアドレスです。このパラメーターを NULL にすると、実装が場所文字列を返さないことを示します。

戻り値

このメソッドは成功時に S_OK を返します。その他の返される可能性のある値には次のものがあります。

戻り値	説明
E_FAIL	操作が失敗しました。
E_INVALIDARG	指定された識別子が無効です。
E_OUTOFMEMORY	この操作に使用できるメモリが不足しています。

解説(Remarks)

文字列とオブジェクトのサイズは、オブジェクトのプロパティの全般ページに表示されます。

実装者への注意

GetObjectInfo の実装では、オブジェクトの各属性を、提供された out パラメーターに格納する必要があります。オブジェクトのサイズが不明な場合は、lpdwObjSize を (DWORD)-1 に設定します。すべての文字列(残りのパラメーター)は、[out] 文字列パラメーターを持つすべての OLE インターフェイスで標準となっているように、CoGetMalloc を介して取得した OLE タスクアロケーターで割り当てます。または、単に CoTaskMemAlloc を使用することもできます。

vtbl 4 HRESULT GetConvertInfo(DWORD dwObject, GUID* lpClassID, WORD* lpwFormat, GUID* lpConvertDefaultClassID, GUID** lplpClsidExclude, DWORD* lpcClsidExclude)

指定されたオブジェクトに関連付けられた変換情報を取得します。(ANSI)

dwObject	DWORD	in	オブジェクトの一意の識別子です。
lpClassID	GUID*	out	オブジェクトの CLSID を返す場所へのポインターです。
lpwFormat	WORD*	out	オブジェクトのクリップボード形式へのポインターです。
lpConvertDefaultClassID	GUID*	out	オブジェクトの変換先として UI から選択された既定のクラスへのポインターです。
lplpClsidExclude	GUID**	out	このオブジェクトのユーザーインターフェイスから除外すべき CLSID の配列へのポインターを受け取るポインター変数のアドレスです。lpcClsidExclude がゼロの場合、lpClsidExclude は NULL に設定されます。
lpcClsidExclude	DWORD*	outoptional	lplpClsidExclude 内の CLSID の数を受け取る出力変数のアドレスです。このパラメーターはゼロにできます。

戻り値

このメソッドは成功時に S_OK を返します。その他の返される可能性のある値には次のものがあります。

戻り値	説明
E_ACCESSDENIED	アクセス許可が不足しています。
E_FAIL	操作が失敗しました。
E_INVALIDARG	指定された識別子が無効です。
E_OUTOFMEMORY	この操作に使用できるメモリが不足しています。

解説(Remarks)

実装者への注意

少なくともオブジェクトの CLSID は設定する必要があります。ストレージの形式が不明な場合、lpwFormat はゼロのままにできます。

vtbl 5 HRESULT ConvertObject(DWORD dwObject, GUID* clsidNew)

オブジェクトを指定された CLSID の種類に変換します。(ANSI)

dwObject	DWORD	in	オブジェクトの一意の識別子です。
clsidNew	GUID*	in	CLSID です。

戻り値

このメソッドは成功時に S_OK を返します。その他の返される可能性のある値には次のものがあります。

戻り値	説明
E_ACCESSDENIED	アクセス許可が不足しています。
E_FAIL	操作が失敗しました。
E_INVALIDARG	指定された識別子が有効ではありません。
E_OUTOFMEMORY	この操作に使用できるメモリが不足しています。

解説(Remarks)

実装者への注意

IOleUIObjInfo::ConvertObject の実装では、オブジェクトを指定された CLSID に変換する必要があります。この変換操作で行われるアクションは、OleUIConvert を呼び出した後に行われるアクションと同様です。

vtbl 6 HRESULT GetViewInfo(DWORD dwObject, HGLOBAL* phMetaPict, DWORD* pdvAspect, INT* pnCurrentScale)

オブジェクトに関連付けられたビュー情報を取得します。(ANSI)

dwObject	DWORD	in	オブジェクトの一意の識別子です。
phMetaPict	HGLOBAL*	inoptional	オブジェクトの現在のアイコンへのポインターです。このパラメーターは NULL にすることができ、その場合は呼び出し元がオブジェクトの現在の表現に関心がないことを示します。
pdvAspect	DWORD*	inoptional	オブジェクトの現在のアスペクトへのポインターです。このパラメーターは NULL にすることができ、その場合は呼び出し元がオブジェクトの現在のアスペクト(たとえば DVASPECT_ICONIC や DVASPECT_CONTENT)に関心がないことを示します。
pnCurrentScale	INT*	inoptional	オブジェクトの現在のスケールへのポインターです。このパラメーターは NULL にすることができ、その場合は呼び出し元がコンテナーのビューでオブジェクトに適用されている現在の拡大縮小率に関心がないことを示します。

戻り値

このメソッドは成功時に S_OK を返します。その他の返される可能性のある値には次のものがあります。

戻り値	説明
E_ACCESSDENIED	アクセス許可が不足しています。
E_FAIL	操作が失敗しました。
E_INVALIDARG	指定された識別子が有効ではありません。
E_OUTOFMEMORY	この操作に使用できるメモリが不足しています。

解説(Remarks)

実装者への注意

オブジェクトの現在のアイコン、アスペクト、およびスケールを設定する必要があります。

vtbl 7 HRESULT SetViewInfo(DWORD dwObject, HGLOBAL hMetaPict, DWORD dvAspect, INT nCurrentScale, BOOL bRelativeToOrig)

オブジェクトに関連付けられたビュー情報を設定します。(ANSI)

dwObject	DWORD	in	オブジェクトの一意の識別子です。
hMetaPict	HGLOBAL	in	新しいアイコンです。
dvAspect	DWORD	in	新しい表示アスペクトまたはビューです。
nCurrentScale	INT	in	新しいスケールです。
bRelativeToOrig	BOOL	in	原点を基準としたオブジェクトの新しいスケールです。スケールをオブジェクトの元のスケールを基準にすべき場合、この値は TRUE です。FALSE の場合、nCurrentScale はオブジェクトの現在のサイズに適用されます。

戻り値

このメソッドは成功時に S_OK を返します。その他の返される可能性のある値には次のものがあります。

戻り値	説明
E_ACCESSDENIED	アクセス許可が不足しています。
E_FAIL	操作が失敗しました。
E_INVALIDARG	指定された識別子が無効です。
E_OUTOFMEMORY	この操作に使用できるメモリが不足しています。

解説(Remarks)

実装者への注意

新しい属性(アイコン、アスペクト、スケール)をオブジェクトに適用する必要があります。bRelativeToOrig が TRUE に設定されている場合、nCurrentScale(パーセント単位)は、拡大縮小される前のオブジェクトの元のサイズに適用されます。bRelativeToOrig が FALSE の場合、nCurrentScale はオブジェクトの現在のサイズに適用されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IOleUIObjInfoA "{}"
#usecom global IOleUIObjInfoA IID_IOleUIObjInfoA "{}"
#comfunc global IOleUIObjInfoA_GetObjectInfo   3 int,var,var,var,var,var
#comfunc global IOleUIObjInfoA_GetConvertInfo  4 int,var,var,var,var,var
#comfunc global IOleUIObjInfoA_ConvertObject   5 int,var
#comfunc global IOleUIObjInfoA_GetViewInfo     6 int,sptr,var,var
#comfunc global IOleUIObjInfoA_SetViewInfo     7 int,sptr,int,int,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IOleUIObjInfoA "{}"
#usecom global IOleUIObjInfoA IID_IOleUIObjInfoA "{}"
#comfunc global IOleUIObjInfoA_GetObjectInfo   3 int,sptr,sptr,sptr,sptr,sptr
#comfunc global IOleUIObjInfoA_GetConvertInfo  4 int,sptr,sptr,sptr,sptr,sptr
#comfunc global IOleUIObjInfoA_ConvertObject   5 int,sptr
#comfunc global IOleUIObjInfoA_GetViewInfo     6 int,sptr,sptr,sptr
#comfunc global IOleUIObjInfoA_SetViewInfo     7 int,sptr,int,int,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。