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

IRelationship

COM
📘 Microsoft Learn (日本語) · English
IID2769280b-5108-498c-9c7f-a51239b63147継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

スキーマプロパティに関する情報を取得するためのメソッドを提供します。

メソッド 5

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

vtbl 3 HRESULT Name(LPWSTR* ppszName)

リレーションシップの名前を取得します。

ppszNameLPWSTR*outoptionalリレーションシップの名前を表す Unicode 文字列へのポインターを受け取ります。呼び出し元のアプリケーションは、CoTaskMemFree を呼び出して、返された文字列を解放する必要があります。

戻り値

型: HRESULT

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

vtbl 4 HRESULT IsReal(BOOL* pIsReal)

リレーションシップが実在する (real) ものかどうかを報告します。

pIsRealBOOL*out実在する (real) リレーションシップの場合は TRUE、それ以外の場合は FALSE を受け取ります。

戻り値

型: HRESULT

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

解説(Remarks)

ソースエンティティが、同じ名前のリレーションシップを持つエンティティから派生している場合、そのリレーションシップは実在する (real) ものとは見なされません。このような「シャドウ」リレーションシップの目的は、継承されたリレーションシップに固有のメタデータを格納することにあります。

vtbl 5 HRESULT Destination(IEntity** pDestinationEntity)

リレーションシップの宛先となる IEntity オブジェクトを取得します。リレーションシップの宛先は、プロパティの型に対応します。

pDestinationEntityIEntity**outIEntity オブジェクトへのポインターのアドレスを受け取ります。リレーションシップが実在しない (real でない) 場合は NULL を受け取ります。詳細については、IRelationship::IsReal を参照してください。

戻り値

型: HRESULT

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

vtbl 6 HRESULT MetaData(GUID* riid, void** pMetaData)

このリレーションシップに対する IMetaData オブジェクトの列挙子を取得します。

riidGUID*in必要とする結果の IID。IID_IEnumUnknown または IID_IEnumVARIANT のいずれかです。
pMetaDatavoid**outIMetaData オブジェクトの列挙子へのポインターを受け取ります。同じキー (または同じ値) を持つペアが複数存在する場合があります。

戻り値

型: HRESULT

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

vtbl 7 HRESULT DefaultPhrase(LPWSTR* ppszPhrase)

再記述 (restatement) においてこのリレーションシップに使用する既定のフレーズを取得します。

ppszPhraseLPWSTR*outoptional既定のフレーズを Unicode 文字列として受け取ります。呼び出し元のアプリケーションは、CoTaskMemFree を呼び出して文字列を解放する必要があります。

戻り値

型: 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_IRelationship "{2769280B-5108-498C-9C7F-A51239B63147}"
#usecom global IRelationship IID_IRelationship "{}"
#comfunc global IRelationship_Name           3 var
#comfunc global IRelationship_IsReal         4 var
#comfunc global IRelationship_Destination    5 sptr
#comfunc global IRelationship_MetaData       6 var,sptr
#comfunc global IRelationship_DefaultPhrase  7 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。