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

INetSharingPortMappingProps

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

公式ドキュメント

INetSharingPortMappingProps インターフェイスは、ネットワーク接続のポートマッピングのプロパティを取得および設定するメソッドを提供します。

メソッド 8

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

vtbl 7 HRESULT get_Name(LPWSTR* pbstrName)

get_Name メソッドは、このポートマッピングの名前を取得します。

pbstrNameLPWSTR*outポートマッピングの名前を受け取る BSTR 変数へのポインター。

戻り値

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

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

戻り値 説明
E_ABORT
操作が中止されました。
E_FAIL
原因不明のエラーが発生しました。
E_INVALIDARG
パラメーターのいずれかが無効です。
E_NOINTERFACE
指定されたインターフェイスはサポートされていません。
E_NOTIMPL
指定されたメソッドは実装されていません。
E_OUTOFMEMORY
必要なメモリを割り当てられませんでした。
E_POINTER
パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED
不明な理由でメソッドが失敗しました。
vtbl 8 HRESULT get_IPProtocol(BYTE* pucIPProt)

get_IPProtocol メソッドは、このポートマッピングに関連付けられた IP プロトコルを取得します。

pucIPProtBYTE*out

ポートマッピングの IP プロトコルを受け取る UCHAR 変数へのポインター。IP プロトコルは次のいずれかの値です。

NAT_PROTOCOL_TCP

NAT_PROTOCOL_UDP

戻り値

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

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

戻り値 説明
E_ABORT
操作が中止されました。
E_FAIL
原因不明のエラーが発生しました。
E_INVALIDARG
パラメーターのいずれかが無効です。
E_NOINTERFACE
指定されたインターフェイスはサポートされていません。
E_NOTIMPL
指定されたメソッドは実装されていません。
E_OUTOFMEMORY
必要なメモリを割り当てられませんでした。
E_POINTER
パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED
不明な理由でメソッドが失敗しました。
vtbl 9 HRESULT get_ExternalPort(INT* pusPort)

get_ExternalPort メソッドは、このポートマッピングに関連付けられた外部ポートを取得します。

pusPortINT*outこのポートマッピングの外部ポートを受け取る LONG 変数へのポインター。

戻り値

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

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

戻り値 説明
E_ABORT
操作が中止されました。
E_FAIL
原因不明のエラーが発生しました。
E_INVALIDARG
パラメーターのいずれかが無効です。
E_NOINTERFACE
指定されたインターフェイスはサポートされていません。
E_NOTIMPL
指定されたメソッドは実装されていません。
E_OUTOFMEMORY
必要なメモリを割り当てられませんでした。
E_POINTER
パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED
不明な理由でメソッドが失敗しました。
vtbl 10 HRESULT get_InternalPort(INT* pusPort)

get_InternalPort メソッドは、このポートマッピングに関連付けられた内部ポートを取得します。

pusPortINT*outこのポートマッピングの内部ポートを受け取る LONG 変数へのポインター。

戻り値

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

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

戻り値 説明
E_ABORT
操作が中止されました。
E_FAIL
原因不明のエラーが発生しました。
E_INVALIDARG
パラメーターのいずれかが無効です。
E_NOINTERFACE
指定されたインターフェイスはサポートされていません。
E_NOTIMPL
指定されたメソッドは実装されていません。
E_OUTOFMEMORY
必要なメモリを割り当てられませんでした。
E_POINTER
パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED
不明な理由でメソッドが失敗しました。
vtbl 11 HRESULT get_Options(INT* pdwOptions)

get_Options メソッドは、このポートマッピングに関連付けられたオプションを取得します。

pdwOptionsINT*outこのポートマッピングに関連付けられたオプションを受け取る DWORD 変数へのポインター。

戻り値

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

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

戻り値 説明
E_ABORT
操作が中止されました。
E_FAIL
原因不明のエラーが発生しました。
E_INVALIDARG
パラメーターのいずれかが無効です。
E_NOINTERFACE
指定されたインターフェイスはサポートされていません。
E_NOTIMPL
指定されたメソッドは実装されていません。
E_OUTOFMEMORY
必要なメモリを割り当てられませんでした。
E_POINTER
パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED
不明な理由でメソッドが失敗しました。
vtbl 12 HRESULT get_TargetName(LPWSTR* pbstrTargetName)

get_TargetName メソッドは、このポートマッピングの対象コンピューターの名前を取得します。

pbstrTargetNameLPWSTR*outこのポートマッピングの対象コンピューターの名前を受け取る BSTR 変数へのポインター。

戻り値

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

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

戻り値 説明
E_ABORT
操作が中止されました。
E_FAIL
原因不明のエラーが発生しました。
E_INVALIDARG
パラメーターのいずれかが無効です。
E_NOINTERFACE
指定されたインターフェイスはサポートされていません。
E_NOTIMPL
指定されたメソッドは実装されていません。
E_OUTOFMEMORY
必要なメモリを割り当てられませんでした。
E_POINTER
パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED
不明な理由でメソッドが失敗しました。
vtbl 13 HRESULT get_TargetIPAddress(LPWSTR* pbstrTargetIPAddress)

get_TargetIPAddress メソッドは、このポートマッピングの対象コンピューターの IP アドレスを取得します。

pbstrTargetIPAddressLPWSTR*outこのポートマッピングの対象コンピューターの IP アドレスを受け取る BSTR 変数へのポインター。

戻り値

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

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

戻り値 説明
E_ABORT
操作が中止されました。
E_FAIL
原因不明のエラーが発生しました。
E_INVALIDARG
パラメーターのいずれかが無効です。
E_NOINTERFACE
指定されたインターフェイスはサポートされていません。
E_NOTIMPL
指定されたメソッドは実装されていません。
E_OUTOFMEMORY
必要なメモリを割り当てられませんでした。
E_POINTER
パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED
不明な理由でメソッドが失敗しました。
vtbl 14 HRESULT get_Enabled(VARIANT_BOOL* pbool)

get_Enabled メソッドは、このポートマッピングの状態を取得します。

pboolVARIANT_BOOL*outポートマッピングの状態を受け取る VARIANT_BOOL 変数へのポインター。

戻り値

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

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

戻り値 説明
E_ABORT
操作が中止されました。
E_FAIL
原因不明のエラーが発生しました。
E_INVALIDARG
パラメーターのいずれかが無効です。
E_NOINTERFACE
指定されたインターフェイスはサポートされていません。
E_NOTIMPL
指定されたメソッドは実装されていません。
E_OUTOFMEMORY
必要なメモリを割り当てられませんでした。
E_POINTER
パラメーターとして渡されたポインターが無効です。
E_UNEXPECTED
不明な理由でメソッドが失敗しました。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_INetSharingPortMappingProps "{24B7E9B5-E38F-4685-851B-00892CF5F940}"
#usecom global INetSharingPortMappingProps IID_INetSharingPortMappingProps "{}"
#comfunc global INetSharingPortMappingProps_get_Name             7 var
#comfunc global INetSharingPortMappingProps_get_IPProtocol       8 var
#comfunc global INetSharingPortMappingProps_get_ExternalPort     9 var
#comfunc global INetSharingPortMappingProps_get_InternalPort     10 var
#comfunc global INetSharingPortMappingProps_get_Options          11 var
#comfunc global INetSharingPortMappingProps_get_TargetName       12 var
#comfunc global INetSharingPortMappingProps_get_TargetIPAddress  13 var
#comfunc global INetSharingPortMappingProps_get_Enabled          14 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。