ホーム › Storage.VirtualDiskService › IVdsSubSystemIscsi

IVdsSubSystemIscsi

COM

📘 Microsoft Learn (日本語) · English

IID0027346f-40d0-4b45-8cec-5906dc0380c8継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IVdsSubSystemIscsi インターフェイス (vdshwprv.h) は、サブシステム上の iSCSI ターゲットおよびポータルを照会し構成するためのメソッドを提供します。

メソッド 4

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

vtbl 3 HRESULT QueryTargets(IEnumVdsObject** ppEnum)

IVdsSubSystemIscsi::QueryTargets (vdshwprv.h) メソッドは、サブシステムの iSCSI ターゲットを列挙するオブジェクトを返します。

ppEnum

IEnumVdsObject**

out

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

戻り値

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

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

vtbl 4 HRESULT QueryPortals(IEnumVdsObject** ppEnum)

IVdsSubSystemIscsi::QueryPortals (vdshwprv.h) メソッドは、サブシステムの iSCSI ポータルを列挙するオブジェクトを返します。

ppEnum

IEnumVdsObject**

out

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

戻り値

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

vtbl 5 HRESULT CreateTarget(LPWSTR pwszIscsiName, LPWSTR pwszFriendlyName, IVdsAsync** ppAsync)

IVdsSubSystemIscsi::CreateTarget (vdshwprv.h) メソッドは、iSCSI ターゲットを作成します。

pwszIscsiName

LPWSTR

ターゲットに割り当てる iSCSI 名を指定する文字列。ターゲット名は、ネットワーク上に表示されるすべてのサブシステム内のすべてのターゲットにわたって一意である必要があります。

pwszIscsiName が NULL または空の文字列を指す場合、プロバイダーがターゲットに割り当てる iSCSI 名を生成します。

pwszFriendlyName

LPWSTR

ターゲットに割り当てるフレンドリ名を指定する文字列。これは iSCSI エイリアスに対応します。

ppAsync

IVdsAsync**

out

VDS が戻り時に初期化する IVdsAsync インターフェイスポインターのアドレス。呼び出し元はインターフェイスを解放する必要があります。このインターフェイスを使用して、操作のキャンセル、完了の待機、または状態の照会を行います。このメソッドで IVdsAsync::Wait を呼び出して成功を示す HRESULT 値が返された場合は、VDS_ASYNC_OUTPUT 構造体で返された各インターフェイスポインターに対して IUnknown::Release メソッドを呼び出してインターフェイスを解放する必要があります。ただし、Wait が失敗を示す HRESULT 値を返した場合、または Wait の pHrResult パラメーターが失敗を示す HRESULT 値を受け取った場合、VDS_ASYNC_OUTPUT 構造体内のインターフェイスポインターは NULL であり、解放する必要はありません。成功または失敗の HRESULT 値は、Winerror.h で定義されている SUCCEEDED および FAILED マクロを使用して判定できます。

戻り値

リターンコード/値	説明
S_OK	ターゲットが正常に作成されました。
VDS_E_NOT_SUPPORTED 0x80042400L	サブシステムオブジェクトはこのメソッドをサポートしていません。これは、ハードウェアプロバイダーがサブシステムオブジェクトの VDS_SUB_SYSTEM_PROP 構造体の ulFlags メンバーに VDS_SF_SUPPORTS_SIMPLE_TARGET_CONFIG フラグを設定していることを示します。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	プロバイダーのキャッシュが破損しています。これは、接続されているデバイスに関する情報をキャッシュするプロバイダー内部のソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続けて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED 0x8004240BL	サブシステムオブジェクトは既に存在しません。
VDS_E_OBJECT_STATUS_FAILED 0x80042431L	サブシステムが失敗状態にあり、要求された操作を実行できません。
VDS_E_ANOTHER_CALL_IN_PROGRESS 0x80042404L	別の操作が進行中です。この操作は、前の操作が完了するまで続行できません。
VDS_E_NAME_NOT_UNIQUE 0x80042701L	pwszIscsiName パラメーターに一意でない名前が指定されました。

vtbl 6 HRESULT SetIpsecGroupPresharedKey(VDS_ISCSI_IPSEC_KEY* pIpsecKey)

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

pIpsecKey

VDS_ISCSI_IPSEC_KEY*

将来の使用のために予約されています。

戻り値

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

リターンコード	説明
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_IVdsSubSystemIscsi "{0027346F-40D0-4B45-8CEC-5906DC0380C8}"
#usecom global IVdsSubSystemIscsi IID_IVdsSubSystemIscsi "{}"
#comfunc global IVdsSubSystemIscsi_QueryTargets               3 sptr
#comfunc global IVdsSubSystemIscsi_QueryPortals               4 sptr
#comfunc global IVdsSubSystemIscsi_CreateTarget               5 wstr,wstr,sptr
#comfunc global IVdsSubSystemIscsi_SetIpsecGroupPresharedKey  6 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IVdsSubSystemIscsi "{0027346F-40D0-4B45-8CEC-5906DC0380C8}"
#usecom global IVdsSubSystemIscsi IID_IVdsSubSystemIscsi "{}"
#comfunc global IVdsSubSystemIscsi_QueryTargets               3 sptr
#comfunc global IVdsSubSystemIscsi_QueryPortals               4 sptr
#comfunc global IVdsSubSystemIscsi_CreateTarget               5 wstr,wstr,sptr
#comfunc global IVdsSubSystemIscsi_SetIpsecGroupPresharedKey  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。