ホーム › Storage.VirtualDiskService › IVdsIscsiPortal

IVdsIscsiPortal

COM

📘 Microsoft Learn (日本語) · English

IID7fa1499d-ec85-4a8a-a47b-ff69201fcd34継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IVdsIscsiPortal インターフェース (vdshwprv.h) は、iSCSI ポータルに対する照会および構成操作を実行するためのメソッドを提供します。

メソッド 7

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetProperties(VDS_ISCSI_PORTAL_PROP* pPortalProp)

IVdsIscsiPortal::GetProperties (vdshwprv.h) メソッドは、ポータルのプロパティを返します。

pPortalProp

VDS_ISCSI_PORTAL_PROP*

out

VDS_ISCSI_PORTAL_PROP 構造体のアドレス。

戻り値

このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、およびVDS 固有の戻り値を返すことができます。また、HRESULT_FROM_WIN32 マクロを使用して変換されたシステムエラーコードを返すこともあります。エラーは、VDS 自体、または使用中の基盤となる VDS プロバイダーから発生する可能性があります。返される可能性のある値には次のものがあります。

戻り値/値	説明
S_OK	プロパティが正常に取得されました。
VDS_S_PROPERTIES_INCOMPLETE 0x00042715L	一部のプロパティは正常に取得されましたが、すべてではありません。すべてのプロパティの取得に失敗する原因は、デバイスの取り外しなど、多数存在する点に注意してください。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	プロバイダーのキャッシュが破損しています。これは、接続されたデバイスに関する情報をキャッシュするプロバイダー内部でのソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続けて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED 0x8004240BL	ポータルオブジェクトは既に存在しません。

vtbl 4 HRESULT GetSubSystem(IVdsSubSystem** ppSubSystem)

IVdsIscsiPortal::GetSubSystem (vdshwprv.h) メソッドは、ポータルが属するサブシステムを返します。

ppSubSystem

IVdsSubSystem**

out

IVdsSubSystem インターフェースポインターのアドレス。呼び出し元はインターフェースを解放する必要があります。

戻り値

戻り値/値	説明
S_OK	サブシステムが正常に取得されました。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	プロバイダーのキャッシュが破損しています。これは、接続されたデバイスに関する情報をキャッシュするプロバイダー内部でのソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続けて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED 0x8004240BL	ポータルオブジェクトは既に存在しません。

vtbl 5 HRESULT QueryAssociatedPortalGroups(IEnumVdsObject** ppEnum)

IVdsIscsiPortal::QueryAssociatedPortalGroups (vdshwprv.h) メソッドは、ポータルが関連付けられているポータルグループの列挙を返します。

ppEnum

IEnumVdsObject**

out

ポータルグループをポータルグループオブジェクトとして列挙するために使用できる IEnumVdsObject インターフェースポインターのアドレス。詳細については、「列挙オブジェクトの操作」を参照してください。呼び出し元は、不要になったインターフェースおよび各ポータルグループオブジェクトを、IUnknown::Release メソッドを呼び出して解放する必要があります。

戻り値

戻り値/値	説明
S_OK	関連付けられているポータルグループの列挙が正常に返されました。ポータルに関連付けられたポータルグループがない場合、列挙は空になります。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	プロバイダーのキャッシュが破損しています。これは、接続されたデバイスに関する情報をキャッシュするプロバイダー内部でのソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続けて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED 0x8004240BL	ポータルオブジェクトは既に存在しません。
VDS_E_ANOTHER_CALL_IN_PROGRESS 0x80042404L	別の操作が進行中です。この操作は、以前の操作が完了するまで実行できません。

vtbl 6 HRESULT SetStatus(VDS_ISCSI_PORTAL_STATUS status)

IVdsIscsiPortal::SetStatus (vdshwprv.h) メソッドは、ポータルの状態を指定された値に設定します。

status

VDS_ISCSI_PORTAL_STATUS

VDS_ISCSI_PORTAL_STATUS によって列挙される値。サポートされる列挙値は VDS_IPS_ONLINE と VDS_IPS_OFFLINE のみです。残りの値は、プロバイダーが状態を報告するためにのみ使用されます。

戻り値

戻り値	説明
S_OK	状態が正常に設定されました。
VDS_E_PROVIDER_CACHE_CORRUPT	プロバイダーのキャッシュが破損しています。これは、接続されたデバイスに関する情報をキャッシュするプロバイダー内部でのソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続けて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED	ポータルオブジェクトは既に存在しません。
VDS_E_ANOTHER_CALL_IN_PROGRESS	別の操作が進行中です。この操作は、以前の操作が完了するまで実行できません。
VDS_E_NOT_SUPPORTED	この操作またはパラメーターの組み合わせは、このプロバイダーではサポートされていません。

vtbl 7 HRESULT SetIpsecTunnelAddress(VDS_IPADDRESS* pTunnelAddress, VDS_IPADDRESS* pDestinationAddress)

IVdsIscsiPortal::SetIpsecTunnelAddress (vdshwprv.h) メソッドはサポートされておらず、将来の使用のために予約されています。

pTunnelAddress	VDS_IPADDRESS*	in	将来の使用のために予約されています。
pDestinationAddress	VDS_IPADDRESS*	in	将来の使用のために予約されています。

戻り値

このメソッドは、これらの値のいずれかを返すことができます。

戻り値	説明
VDS_E_NOT_SUPPORTED	このメソッドは、このリリースではサポートされていません。

vtbl 8 HRESULT GetIpsecSecurity(VDS_IPADDRESS* pInitiatorPortalAddress, ULONGLONG* pullSecurityFlags)

IVdsIscsiPortal::GetIpsecSecurity (vdshwprv.h) メソッドはサポートされていませんが、将来の使用のために予約されています。

pInitiatorPortalAddress	VDS_IPADDRESS*	in	将来の使用のために予約されています。
pullSecurityFlags	ULONGLONG*	out	将来の使用のために予約されています。

戻り値

このメソッドは、これらの値のいずれかを返すことができます。

戻り値	説明
VDS_E_NOT_SUPPORTED	このメソッドは、このリリースではサポートされていません。

vtbl 9 HRESULT SetIpsecSecurity(VDS_IPADDRESS* pInitiatorPortalAddress, ULONGLONG ullSecurityFlags, VDS_ISCSI_IPSEC_KEY* pIpsecKey)

IVdsIscsiPortal::SetIpsecSecurity (vdshwprv.h) メソッドはサポートされておらず、将来の使用のために予約されています。

pInitiatorPortalAddress	VDS_IPADDRESS*	in	将来の使用のために予約されています。
ullSecurityFlags	ULONGLONG	in	将来の使用のために予約されています。
pIpsecKey	VDS_ISCSI_IPSEC_KEY*	in	将来の使用のために予約されています。

戻り値

このメソッドは、これらの値のいずれかを返すことができます。

戻り値	説明
VDS_E_NOT_SUPPORTED	このメソッドは、このリリースではサポートされていません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IVdsIscsiPortal "{7FA1499D-EC85-4A8A-A47B-FF69201FCD34}"
#usecom global IVdsIscsiPortal IID_IVdsIscsiPortal "{}"
#comfunc global IVdsIscsiPortal_GetProperties                3 var
#comfunc global IVdsIscsiPortal_GetSubSystem                 4 sptr
#comfunc global IVdsIscsiPortal_QueryAssociatedPortalGroups  5 sptr
#comfunc global IVdsIscsiPortal_SetStatus                    6 int
#comfunc global IVdsIscsiPortal_SetIpsecTunnelAddress        7 var,var
#comfunc global IVdsIscsiPortal_GetIpsecSecurity             8 var,var
#comfunc global IVdsIscsiPortal_SetIpsecSecurity             9 var,int64,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IVdsIscsiPortal "{7FA1499D-EC85-4A8A-A47B-FF69201FCD34}"
#usecom global IVdsIscsiPortal IID_IVdsIscsiPortal "{}"
#comfunc global IVdsIscsiPortal_GetProperties                3 sptr
#comfunc global IVdsIscsiPortal_GetSubSystem                 4 sptr
#comfunc global IVdsIscsiPortal_QueryAssociatedPortalGroups  5 sptr
#comfunc global IVdsIscsiPortal_SetStatus                    6 int
#comfunc global IVdsIscsiPortal_SetIpsecTunnelAddress        7 sptr,sptr
#comfunc global IVdsIscsiPortal_GetIpsecSecurity             8 sptr,sptr
#comfunc global IVdsIscsiPortal_SetIpsecSecurity             9 sptr,int64,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。