Win32 API 日本語リファレンス
ホームNetworkManagement.WindowsFirewall › INetFwRules

INetFwRules

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID9c4c6277-5027-441e-afae-ca1f542da009継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ファイアウォール規則のコレクションです。

メソッド 5

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_Count(INT* count)

コレクション内の規則の数を返します。

countINT*outコレクション内のファイアウォール規則の数を受け取る整数へのポインタである。
vtbl 8 HRESULT Add(INetFwRule* rule)

Add メソッドは、コレクションに新しい規則を追加します。

ruleINetFwRule*inINetFwRule オブジェクトを介してコレクションに追加する規則。

戻り値

C++

メソッドが成功した場合、戻り値は S_OK です。

メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。

戻り値 説明
E_ACCESSDENIED
アクセス許可の問題により操作が中止されました。
E_INVALIDARG
パラメーターが無効であったため、メソッドが失敗しました。
E_UNEXPECTED
オブジェクトが既にコレクションに存在するため、メソッドが失敗しました。

VB

メソッドが成功した場合、戻り値は S_OK です。

メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。

戻り値 説明
E_ACCESSDENIED
アクセス許可の問題により操作が中止されました。
E_INVALIDARG
パラメーターが無効であったため、メソッドが失敗しました。
E_UNEXPECTED
オブジェクトが既にコレクションに存在するため、メソッドが失敗しました。

解説(Remarks)

送信された規則と同じ規則識別子を持つ規則が既に存在する場合、既存の規則は上書きされます。

LocalAppPackageId を指定したファイアウォール規則を追加すると、予期しない動作を引き起こす可能性があり、サポートされていません。

vtbl 9 HRESULT Remove(LPWSTR name)

Remove メソッドは、コレクションから規則を削除します。

nameLPWSTRinコレクションから削除する規則の名前。

戻り値

C++

メソッドが成功した場合、戻り値は S_OK です。

メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。

戻り値 説明
E_ACCESSDENIED
アクセス許可の問題により操作が中止されました。
E_INVALIDARG
無効なパラメーターにより、メソッドが失敗しました。
E_OUTOFMEMORY
必要なメモリを割り当てられませんでした。

VB

メソッドが成功した場合、戻り値は S_OK です。

メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。

戻り値 説明
E_ACCESSDENIED
アクセス許可の問題により操作が中止されました。
E_INVALIDARG
無効なパラメーターにより、メソッドが失敗しました。
E_OUTOFMEMORY
必要なメモリを割り当てられませんでした。

解説(Remarks)

name パラメーターで指定された規則がコレクションに存在しない場合、Remove メソッドは何も行いません。

vtbl 10 HRESULT Item(LPWSTR name, INetFwRule** rule)

Item メソッドは、指定された規則がコレクションに存在する場合、その規則を返します。

nameLPWSTRin取得する規則の名前。
ruleINetFwRule**out返される INetFwRule オブジェクトへの参照。

戻り値

C++

メソッドが成功した場合、戻り値は S_OK です。

メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。

戻り値 説明
E_ACCESSDENIED
アクセス許可の問題により操作が中止されました。
E_INVALIDARG
無効なパラメーターにより、メソッドが失敗しました。
E_OUTOFMEMORY
必要なメモリを割り当てられませんでした。
E_POINTER
無効なポインターにより、メソッドが失敗しました。
HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND)
要求された項目は存在しません。

VB

メソッドが成功した場合、戻り値は S_OK です。

メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。

戻り値 説明
E_ACCESSDENIED
アクセス許可の問題により操作が中止されました。
E_INVALIDARG
無効なパラメーターにより、メソッドが失敗しました。
E_OUTOFMEMORY
必要なメモリを割り当てられませんでした。
E_POINTER
無効なポインターにより、メソッドが失敗しました。
HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND)
要求された項目は存在しません。
vtbl 11 HRESULT get__NewEnum(IUnknown** newEnum)

コレクション内のすべての規則を列挙するために使用できる、IEnumVARIANT をサポートするオブジェクトを返します。

newEnumIUnknown**outコレクションを反復処理するための列挙子オブジェクト (IEnumVARIANT) を表す IUnknown インターフェイスを受け取るポインタである。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_INetFwRules "{9C4C6277-5027-441E-AFAE-CA1F542DA009}"
#usecom global INetFwRules IID_INetFwRules "{}"
#comfunc global INetFwRules_get_Count     7 var
#comfunc global INetFwRules_Add           8 sptr
#comfunc global INetFwRules_Remove        9 wstr
#comfunc global INetFwRules_Item          10 wstr,sptr
#comfunc global INetFwRules_get__NewEnum  11 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。