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

INetFwOpenPort

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

公式ドキュメント

INetFwOpenPort インターフェイスは、ファイアウォールで開かれたポートのプロパティへのアクセスを提供します。

解説(Remarks)

BuiltIn プロパティが true (VARIANT_TRUE) に設定されているポートはシステムによって指定されたものであり、削除できません。

新しいポートを作成する場合、このインターフェイスは HNetCfg.FWOpenPort COM オブジェクトによってサポートされます。

既存のポートの読み取りまたは変更を行う場合、 このインターフェイスのインスタンスは INetFwOpenPorts コレクションから取得します。

すべての構成変更は直ちに有効になります。

メソッド 15

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

vtbl 7 HRESULT get_Name(LPWSTR* name)

このポートのフレンドリ名を指定します。(Get)

nameLPWSTR*outこの開放ポートの名前を表す文字列(BSTR)を受け取るポインタへのポインタである。

解説(Remarks)

このプロパティは必須です。

vtbl 8 HRESULT put_Name(LPWSTR name)

このポートのフレンドリ名を指定します。(Put)

nameLPWSTRinこの開放ポートに設定する名前を表す文字列(BSTR)を指定する。

解説(Remarks)

このプロパティは必須です。

vtbl 9 HRESULT get_IpVersion(NET_FW_IP_VERSION* ipVersion)

このポートの IP バージョン設定を指定します。(Get)

ipVersionNET_FW_IP_VERSION*outこのポートに適用される IP バージョンを示す NET_FW_IP_VERSION 列挙値を受け取るポインタである。

解説(Remarks)

NET_FW_IP_VERSION_ANY のみがサポートされ、新しいポートの既定値でもあります。

vtbl 10 HRESULT put_IpVersion(NET_FW_IP_VERSION ipVersion)

このポートの IP バージョン設定を指定します。(Put)

ipVersionNET_FW_IP_VERSIONinこのポートに適用する IP バージョンを示す NET_FW_IP_VERSION 列挙値を指定する。

解説(Remarks)

NET_FW_IP_VERSION_ANY のみがサポートされ、新しいポートの既定値でもあります。

vtbl 11 HRESULT get_Protocol(NET_FW_IP_PROTOCOL* ipProtocol)

このポートのプロトコル種別の設定を指定します。(Get)

ipProtocolNET_FW_IP_PROTOCOL*outこのポートのプロトコルを示す NET_FW_IP_PROTOCOL 列挙値を受け取るポインタである。

解説(Remarks)

新しいポートの既定のプロトコル種別は TCP です。

vtbl 12 HRESULT put_Protocol(NET_FW_IP_PROTOCOL ipProtocol)

このポートのプロトコル種別の設定を指定します。(Put)

ipProtocolNET_FW_IP_PROTOCOLinこのポートに設定するプロトコルを示す NET_FW_IP_PROTOCOL 列挙値を指定する。

解説(Remarks)

新しいポートの既定のプロトコル種別は TCP です。

vtbl 13 HRESULT get_Port(INT* portNumber)

このポートのポート番号 (ホストバイトオーダー) を指定します。(Get)

portNumberINT*outこのポートの番号を受け取るポインタである。
vtbl 14 HRESULT put_Port(INT portNumber)

このポートのポート番号 (ホストバイトオーダー) を指定します。(Put)

portNumberINTinこのポートに設定するポート番号を指定する。
vtbl 15 HRESULT get_Scope(NET_FW_SCOPE* scope)

ポートが受信を待ち受けるネットワークスコープを制御します。(INetFwOpenPort.get_Scope)

scopeNET_FW_SCOPE*outこのポートへのアクセスが許可されるネットワークスコープを示す NET_FW_SCOPE 列挙値を受け取るポインタである。

解説(Remarks)

Scope プロパティを設定する際に有効なのは、 NET_FW_SCOPE_ALLNET_FW_SCOPE_LOCAL_SUBNET のみです。

新しいポートの既定値は NET_FW_SCOPE_ALL です。

カスタムスコープを作成するには、RemoteAddresses プロパティを使用します。

vtbl 16 HRESULT put_Scope(NET_FW_SCOPE scope)

ポートが受信を待ち受けるネットワークスコープを制御します。(INetFwOpenPort.put_Scope)

scopeNET_FW_SCOPEinこのポートへのアクセスを許可するネットワークスコープを示す NET_FW_SCOPE 列挙値を指定する。

解説(Remarks)

Scope プロパティを設定する際に有効なのは、 NET_FW_SCOPE_ALLNET_FW_SCOPE_LOCAL_SUBNET のみです。

新しいポートの既定値は NET_FW_SCOPE_ALL です。

カスタムスコープを作成するには、RemoteAddresses プロパティを使用します。

vtbl 17 HRESULT get_RemoteAddresses(LPWSTR* remoteAddrs)

ポートがトラフィックを待ち受けるリモートアドレスのセットを指定します。(Get)

remoteAddrsLPWSTR*outこのポートへのアクセスを許可するリモートアドレスの一覧を表す文字列(BSTR)を受け取るポインタへのポインタである。

解説(Remarks)

remoteAddrs パラメーターは、アプリケーションがトラフィックを待ち受けるリモートアドレスを指定する、1 つ以上のカンマ区切りトークンで構成されます。既定値は "*" です。

有効なトークン:

定義済みのアドレス範囲を使用するには、Scope プロパティを使用します。
vtbl 18 HRESULT put_RemoteAddresses(LPWSTR remoteAddrs)

ポートがトラフィックを待ち受けるリモートアドレスのセットを指定します。(Put)

remoteAddrsLPWSTRinこのポートへのアクセスを許可するリモートアドレスの一覧を表す文字列(BSTR)を指定する。

解説(Remarks)

remoteAddrs パラメーターは、アプリケーションがトラフィックを待ち受けるリモートアドレスを指定する、1 つ以上のカンマ区切りトークンで構成されます。既定値は "*" です。

有効なトークン:

定義済みのアドレス範囲を使用するには、Scope プロパティを使用します。
vtbl 19 HRESULT get_Enabled(VARIANT_BOOL* enabled)

このポートの設定が現在有効かどうかを示します。(Get)

enabledVARIANT_BOOL*outこのポートの開放が有効かどうかを示すブール値(VARIANT_BOOL)を受け取るポインタである。

解説(Remarks)

このプロパティを false (VARIANT_FALSE) に設定すると、実際にポートを開くことなく、ポートの設定を INetFWOpenPorts コレクションに格納できます。

新しいポートの既定値は true (VARIANT_TRUE) です。

vtbl 20 HRESULT put_Enabled(VARIANT_BOOL enabled)

このポートの設定が現在有効かどうかを示します。(Put)

enabledVARIANT_BOOLinこのポートの開放を有効にするかどうかを示すブール値(VARIANT_BOOL)を指定する。

解説(Remarks)

このプロパティを false (VARIANT_FALSE) に設定すると、実際にポートを開くことなく、ポートの設定を INetFWOpenPorts コレクションに格納できます。

新しいポートの既定値は true (VARIANT_TRUE) です。

vtbl 21 HRESULT get_BuiltIn(VARIANT_BOOL* builtIn)

ポートがシステムによって定義されているかどうかを示します。

builtInVARIANT_BOOL*outこのポートが組み込み(システム定義)かどうかを示すブール値(VARIANT_BOOL)を受け取るポインタである。

解説(Remarks)

BuiltIn プロパティが true (VARIANT_TRUE) に設定されているポートはシステムによって指定されたものであり、削除できません。変更できるのは EnabledRemoteAddressScope の各プロパティのみです。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_INetFwOpenPort "{E0483BA0-47FF-4D9C-A6D6-7741D0B195F7}"
#usecom global INetFwOpenPort IID_INetFwOpenPort "{0CA545C6-37AD-4A6C-BF92-9F7610067EF5}"
#comfunc global INetFwOpenPort_get_Name             7 var
#comfunc global INetFwOpenPort_put_Name             8 wstr
#comfunc global INetFwOpenPort_get_IpVersion        9 var
#comfunc global INetFwOpenPort_put_IpVersion        10 int
#comfunc global INetFwOpenPort_get_Protocol         11 var
#comfunc global INetFwOpenPort_put_Protocol         12 int
#comfunc global INetFwOpenPort_get_Port             13 var
#comfunc global INetFwOpenPort_put_Port             14 int
#comfunc global INetFwOpenPort_get_Scope            15 var
#comfunc global INetFwOpenPort_put_Scope            16 int
#comfunc global INetFwOpenPort_get_RemoteAddresses  17 var
#comfunc global INetFwOpenPort_put_RemoteAddresses  18 wstr
#comfunc global INetFwOpenPort_get_Enabled          19 var
#comfunc global INetFwOpenPort_put_Enabled          20 int
#comfunc global INetFwOpenPort_get_BuiltIn          21 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。