ホーム › System.SettingsManagementInfrastructure › ISettingsNamespace
ISettingsNamespace
COM公式ドキュメント
設定の設定、取得、検証、および名前空間インスタンスに対する変更の保存を行う操作を実行します。
メソッド 7
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
vtbl 3 HRESULT GetIdentity(ISettingsIdentity** SettingsID)
名前空間の識別情報を取得します。
| SettingsID | ISettingsIdentity** | out | 名前空間の識別情報を表す ISettingsIdentity オブジェクトへのポインター。 |
戻り値
このメソッドは HRESULT 値を返します。S_OK は成功を示します。ユーザーに情報を返すためのリソースが不足している場合は E_OUTOFMEMORY を返すことがあります。
vtbl 4 HRESULT Settings(IItemEnumerator** Settings)
名前空間の最上位設定に対する列挙子を取得します。
| Settings | IItemEnumerator** | out | この名前空間のすべての設定にアクセスするためのメソッドを提供する IItemEnumerator オブジェクトへのポインター。 |
戻り値
このメソッドは HRESULT 値を返します。S_OK は成功を示します。ユーザーに情報を返すためのリソースが不足している場合は E_OUTOFMEMORY を返すことがあります。
vtbl 5 HRESULT Save(BOOL PushSettings, ISettingsResult** Result)
設定名前空間を永続的かつ可視の状態に更新します。
| PushSettings | BOOL | in | 使用されません。設定をレジストリに転送するか初期化ファイルに転送するかを制御するフラグ。 |
| Result | ISettingsResult** | out | 名前空間の保存中に発生した可能性のあるエラーを格納する ISettingsResult オブジェクトへのポインター。 |
戻り値
このメソッドは HRESULT 値を返します。S_OK は成功を示します。
vtbl 6 HRESULT GetSettingByPath(LPWSTR Path, ISettingsItem** Setting)
パスで指定された設定オブジェクトを取得します。
| Path | LPWSTR | in | オブジェクトのパス。 |
| Setting | ISettingsItem** | out | 取得したオブジェクトを表す ISettingsItem オブジェクトへのポインター。 |
戻り値
このメソッドは次のいずれかの値を返すことがあります。
| 戻り値 | 説明 |
|---|---|
| 成功を示します。 | |
| 存在しない項目を取得しようとしたことを示します。 | |
| パスの形式が正しくないことを示します。 | |
| パスに認識できない XML エスケープシーケンスが含まれていることを示します。 | |
| パスの指定が正しくなく、リスト項目に対して誤ったキーを参照していることを示します。 |
vtbl 7 HRESULT CreateSettingByPath(LPWSTR Path, ISettingsItem** Setting)
パスで指定された設定オブジェクトを作成します。
| Path | LPWSTR | in | 設定オブジェクトのパス。 |
| Setting | ISettingsItem** | out | 作成された設定を表す ISettingsItem オブジェクトへのポインター。 |
戻り値
このメソッドは次のいずれかの値を返すことがあります。
| 戻り値 | 説明 |
|---|---|
| 成功を示します。 | |
| リスト要素ではない新しい項目を作成しようとしたことを示します。 | |
| キーに指定された値を適切な型に変換できないリスト項目を作成しようとしたことを示します。 | |
| 項目が読み取り専用であるか、名前空間が ReadOnly モードで開かれているために、項目を書き込めないことを示します。 | |
| パスの形式が正しくないことを示します。 | |
| パスに認識できない XML エスケープシーケンスが含まれていることを示します。 | |
| パスの指定が正しくなく、リスト項目に対して誤ったキーを参照していることを示します。 |
パスで指定された設定オブジェクトを削除します。
| Path | LPWSTR | in | 設定オブジェクトのパス。 |
戻り値
このメソッドは次のいずれかの値を返すことがあります。
| 戻り値 | 説明 |
|---|---|
| 成功を示します。 | |
| 存在しない項目を削除しようとしたことを示します。 | |
|
リストに存在しない要素を削除しようとしたことを示します。 |
| 項目が読み取り専用であるか、名前空間が ReadOnly モードで開かれているために、項目を書き込めないことを示します。 | |
| パスの形式が正しくないことを示します。 | |
| パスに認識できない XML エスケープシーケンスが含まれていることを示します。 | |
| パスの指定が正しくなく、リスト項目に対して誤ったキーを参照していることを示します。 |
名前空間の属性の値を取得します。
| Name | LPWSTR | in | 属性の名前。 |
| Value | VARIANT* | out | 属性の値。 |
戻り値
このメソッドは次のいずれかの値を返すことがあります。
| 戻り値 | 説明 |
|---|---|
| 成功を示します。 | |
| 要求された属性が項目に指定されていないことを示します。 | |
| ユーザーに情報を返すためのリソースが不足していることを示します。 |
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
出力引数:
#define global IID_ISettingsNamespace "{9F7D7BBA-20B3-11DA-81A5-0030F1642E3C}" #usecom global ISettingsNamespace IID_ISettingsNamespace "{}" #comfunc global ISettingsNamespace_GetIdentity 3 sptr #comfunc global ISettingsNamespace_Settings 4 sptr #comfunc global ISettingsNamespace_Save 5 int,sptr #comfunc global ISettingsNamespace_GetSettingByPath 6 wstr,sptr #comfunc global ISettingsNamespace_CreateSettingByPath 7 wstr,sptr #comfunc global ISettingsNamespace_RemoveSettingByPath 8 wstr #comfunc global ISettingsNamespace_GetAttribute 9 wstr,var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ISettingsNamespace "{9F7D7BBA-20B3-11DA-81A5-0030F1642E3C}" #usecom global ISettingsNamespace IID_ISettingsNamespace "{}" #comfunc global ISettingsNamespace_GetIdentity 3 sptr #comfunc global ISettingsNamespace_Settings 4 sptr #comfunc global ISettingsNamespace_Save 5 int,sptr #comfunc global ISettingsNamespace_GetSettingByPath 6 wstr,sptr #comfunc global ISettingsNamespace_CreateSettingByPath 7 wstr,sptr #comfunc global ISettingsNamespace_RemoveSettingByPath 8 wstr #comfunc global ISettingsNamespace_GetAttribute 9 wstr,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。