IEntity
COM公式ドキュメント
スキーマ内のエンティティ型に関する情報を取得するためのメソッドを提供します。
メソッド 8
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
このエンティティの名前を取得します。
| ppszName | LPWSTR* | outoptional | このエンティティの名前を表す Unicode 文字列へのポインターを受け取ります。呼び出し元のアプリケーションは、CoTaskMemFree を呼び出して、返された文字列を解放する必要があります。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
解説(Remarks)
各名前は一意である必要があります。
このエンティティの親エンティティを取得します。
| pBaseEntity | IEntity** | out | 親の IEntity オブジェクトへのポインターを受け取ります。親エンティティが存在しない場合は NULL になります。 |
戻り値
型: HRESULT
次のいずれかを返します。それ以外の場合はエラー値を返します。
| 戻り値 | 説明 |
|---|---|
| pBaseEntity が正常に設定されました。 | |
| このエンティティには親がありません。pBaseEntity は NULL に正常に設定されました。 |
解説(Remarks)
各エンティティは他のエンティティから派生します。ただし Entity という名前のエンティティは例外で、このメソッドは S_FALSE を返します。派生したエンティティは、ベースエンティティのすべてのリレーションシップを継承します。
このエンティティが持つリレーションシップごとに 1 つずつ、IRelationship オブジェクトの列挙を取得します。
| riid | GUID* | in | 結果として必要な IID。IID_IEnumUnknown または IID_IEnumVARIANT のいずれかです。 |
| pRelationships | void** | out | IRelationship オブジェクトの列挙へのポインターのアドレスを受け取ります。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
名前で指定された、このエンティティの IRelationship オブジェクトを取得します。
| pszRelationName | LPWSTR | in | 検索するリレーションシップの名前。 |
| pRelationship | IRelationship** | out | 要求された IRelationship オブジェクトへのポインターのアドレスを受け取ります。指定した名前のリレーションシップがこのエンティティに存在しない場合は NULL になります。 |
戻り値
このエンティティの IMetaData オブジェクトの列挙を取得します。
| riid | GUID* | in | 結果として必要な IID。IID_IEnumUnknown または IID_IEnumVARIANT のいずれかです。 |
| pMetaData | void** | out | IMetaData オブジェクトの列挙へのポインターのアドレスを受け取ります。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
この型の既知の名前付きエンティティごとに 1 つずつ、INamedEntity オブジェクトの列挙を取得します。
| riid | GUID* | in | 結果として必要な IID。IID_IEnumUnknown または IID_IEnumVARIANT のいずれかです。 |
| pNamedEntities | void** | out | この型の既知の名前付きエンティティごとに 1 つずつ、INamedEntity オブジェクトの列挙へのポインターのアドレスを受け取ります。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
エンティティ名に基づいて INamedEntity オブジェクトを取得します。
| pszValue | LPWSTR | in | 検索するエンティティの名前。 |
| ppNamedEntity | INamedEntity** | out | pszValue で名前を指定した INamedEntity オブジェクトへのポインターを受け取ります。名前付きエンティティが見つからなかった場合は NULL になります。 |
戻り値
型: HRESULT
成功した場合は S_OK を返します。名前付きエンティティが見つからない場合は S_False を返します。
言い換え (restatement) においてこのエンティティに使用する既定のフレーズを取得します。
| ppszPhrase | LPWSTR* | outoptional | 既定のフレーズを表す Unicode 文字列へのポインターを受け取ります。呼び出し元のアプリケーションは、CoTaskMemFree を呼び出して、返された文字列を解放する必要があります。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IEntity "{24264891-E80B-4FD3-B7CE-4FF2FAE8931F}" #usecom global IEntity IID_IEntity "{}" #comfunc global IEntity_Name 3 var #comfunc global IEntity_Base 4 sptr #comfunc global IEntity_Relationships 5 var,sptr #comfunc global IEntity_GetRelationship 6 wstr,sptr #comfunc global IEntity_MetaData 7 var,sptr #comfunc global IEntity_NamedEntities 8 var,sptr #comfunc global IEntity_GetNamedEntity 9 wstr,sptr #comfunc global IEntity_DefaultPhrase 10 var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IEntity "{24264891-E80B-4FD3-B7CE-4FF2FAE8931F}" #usecom global IEntity IID_IEntity "{}" #comfunc global IEntity_Name 3 sptr #comfunc global IEntity_Base 4 sptr #comfunc global IEntity_Relationships 5 sptr,sptr #comfunc global IEntity_GetRelationship 6 wstr,sptr #comfunc global IEntity_MetaData 7 sptr,sptr #comfunc global IEntity_NamedEntities 8 sptr,sptr #comfunc global IEntity_GetNamedEntity 9 wstr,sptr #comfunc global IEntity_DefaultPhrase 10 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。