Win32 API 日本語リファレンス
ホーム › Storage.VirtualDiskService › IVdsIscsiInitiatorAdapter

IVdsIscsiInitiatorAdapter

COM
📘 Microsoft Learn (日本語) · English
IIDb07fedd4-1682-4440-9189-a39b55194dc5継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ローカルシステム上の iSCSI イニシエーターアダプターを照会し、操作するためのメソッドを提供します。

メソッド 4

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

vtbl 3 HRESULT GetProperties(VDS_ISCSI_INITIATOR_ADAPTER_PROP* pInitiatorAdapterProp)

イニシエーターアダプターのプロパティを返します。

pInitiatorAdapterPropVDS_ISCSI_INITIATOR_ADAPTER_PROP*out呼び出し元が割り当てた VDS_ISCSI_INITIATOR_ADAPTER_PROP 構造体のアドレスです。VDS は pwszName メンバー文字列のメモリを割り当てます。呼び出し元は、CoTaskMemFree 関数を使用してこの文字列を解放する必要があります。

戻り値

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

リターンコード/値 説明
S_OK
 プロパティが正常に返されました。
VDS_S_PROPERTIES_INCOMPLETE
0x00042715L
 一部のプロパティは正常に取得されましたが、すべてではありません。デバイスの取り外しなど、すべてのプロパティを取得できない理由は数多くあることに注意してください。
vtbl 4 HRESULT QueryInitiatorPortals(IEnumVdsObject** ppEnum)

イニシエーターアダプターの iSCSI イニシエーターポータルを列挙するオブジェクトを返します。

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

戻り値

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

リターンコード 説明
S_OK
 イニシエーターポータルの列挙が正常に返されました。イニシエーターアダプターにポータルがない場合、列挙は空になります。
vtbl 5 HRESULT LoginToTarget(VDS_ISCSI_LOGIN_TYPE loginType, GUID targetId, GUID targetPortalId, GUID initiatorPortalId, DWORD ulLoginFlags, BOOL bHeaderDigest, BOOL bDataDigest, VDS_ISCSI_AUTH_TYPE authType, IVdsAsync** ppAsync)

iSCSI ターゲットへの手動ログインを実行します。

loginTypeVDS_ISCSI_LOGIN_TYPEin実行するログインの種類で、VDS_ISCSI_LOGIN_TYPE によって列挙されます。
targetIdGUIDinログイン先のターゲットの VDS_OBJECT_ID です。GUID_NULL は、イニシエーターがポータルを選択することを示します。
targetPortalIdGUIDinログイン操作を実行するターゲットポータルの VDS_OBJECT_ID です。GUID_NULL は、イニシエーターがポータルを選択することを示します。
initiatorPortalIdGUIDinログイン操作を実行するイニシエーターポータルの VDS_OBJECT_ID です。
ulLoginFlagsDWORDinログインオプションを指定する、VDS_ISCSI_LOGIN_FLAG によって列挙されるフラグです。
bHeaderDigestBOOLinTRUE の場合、イニシエーターはターゲットポータルへのログイン時にヘッダーダイジェストを有効にする必要があります。
bDataDigestBOOLinTRUE の場合、イニシエーターはターゲットポータルへのログイン時にデータダイジェストを有効にする必要があります。
authTypeVDS_ISCSI_AUTH_TYPEinターゲットへのログインに必要な認証の種類で、VDS_ISCSI_AUTH_TYPE によって列挙されます。
ppAsyncIVdsAsync**outIVdsAsync インターフェイスポインターのアドレスです。VDS は戻り時にこのインターフェイスを初期化します。呼び出し元はこのインターフェイスを解放する必要があります。このインターフェイスを使用して、操作のキャンセル、完了の待機、または状態の照会を行います。このインターフェイスで IVdsAsync::Wait が呼び出され、成功を示す HRESULT 値が返された場合、VDS_ASYNC_OUTPUT 構造体で返される各インターフェイスポインターに対して IUnknown::Release メソッドを呼び出して解放する必要があります。ただし、Wait が失敗を示す HRESULT 値を返した場合、または Wait の pHrResult パラメーターが失敗を示す HRESULT 値を受け取った場合、VDS_ASYNC_OUTPUT 構造体内のインターフェイスポインターは NULL であり、解放する必要はありません。成功または失敗を示す HRESULT 値は、Winerror.h で定義されている SUCCEEDED マクロおよび FAILED マクロを使用してテストできます。

戻り値

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

リターンコード/値 説明
S_OK
 ログインが正常に完了しました。
VDS_E_ISCSI_LOGIN_FAILED
0x80042708L
 別の操作が進行中です。この操作は、前の操作が完了するまで続行できません。
vtbl 6 HRESULT LogoutFromTarget(GUID targetId, IVdsAsync** ppAsync)

指定したターゲットへのすべての iSCSI セッションで、iSCSI ターゲットからの手動ログアウトを実行します。

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

戻り値

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

リターンコード/値 説明
S_OK
 ポータルグループが正常に削除されました。
VDS_E_ISCSI_LOGOUT_FAILED
0x80042709L
 ログアウトに失敗しました。
VDS_E_ISCSI_SESSION_NOT_FOUND
0x8004270AL
 VDS は、指定したターゲットに一致するセッションを見つけられませんでした。
VDS_E_ISCSI_LOGOUT_INCOMPLETE
0x80042710L
 少なくとも 1 つのセッションが正常にログアウトしませんでした。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IVdsIscsiInitiatorAdapter "{B07FEDD4-1682-4440-9189-A39B55194DC5}"
#usecom global IVdsIscsiInitiatorAdapter IID_IVdsIscsiInitiatorAdapter "{}"
#comfunc global IVdsIscsiInitiatorAdapter_GetProperties          3 var
#comfunc global IVdsIscsiInitiatorAdapter_QueryInitiatorPortals  4 sptr
#comfunc global IVdsIscsiInitiatorAdapter_LoginToTarget          5 int,int,int,int,int,int,int,int,sptr
#comfunc global IVdsIscsiInitiatorAdapter_LogoutFromTarget       6 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。