ホーム › Storage.VirtualDiskService › IVdsControllerPort

IVdsControllerPort

COM

📘 Microsoft Learn (日本語) · English

IID18691d0d-4e7f-43e8-92e4-cf44beeed11c継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IVdsControllerPort (vdshwprv.h) インターフェイスは、コントローラーポートに対するクエリおよび構成操作を実行するためのメソッドを提供します。

メソッド 5

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

vtbl 3 HRESULT GetProperties(VDS_PORT_PROP* pPortProp)

IVdsControllerPort::GetProperties メソッド (vdshwprv.h) は、コントローラーポートのプロパティを取得します。

pPortProp

VDS_PORT_PROP*

out

呼び出し元によって割り当てられ、渡される VDS_PORT_PROP 構造体のメンバーのアドレスです。VDS は pwszFriendlyName および pwszIdentification 文字列のメモリを割り当てます。呼び出し元は CoTaskMemFree 関数を使用して、これらの文字列を解放する必要があります。

戻り値

このメソッドは、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 GetController(IVdsController** ppController)

IVdsControllerPort::GetController メソッド (vdshwprv.h) は、コントローラーポートが属するコントローラーを返します。

ppController

IVdsController**

out

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

戻り値

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

vtbl 5 HRESULT QueryAssociatedLuns(IEnumVdsObject** ppEnum)

IVdsControllerPort::QueryAssociatedLuns メソッド (vdshwprv.h) は、コントローラーポートが関連付けられている LUN の列挙を返します。

ppEnum

IEnumVdsObject**

out

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

戻り値

リターンコード/値	説明
S_OK	関連付けられた LUN の列挙が正常に返されました。コントローラーポートに関連付けられた LUN がない場合、列挙は空になります。
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_NOT_SUPPORTED 0x80042400L	この操作は、このプロバイダーではサポートされていません。

vtbl 6 HRESULT Reset()

IVdsControllerPort::Reset メソッド (vdshwprv.h) は、コントローラーポートを再初期化します。

戻り値

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

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

vtbl 7 HRESULT SetStatus(VDS_PORT_STATUS status)

IVdsControllerPort::SetStatus メソッド (vdshwprv.h) は、コントローラーポートの状態を指定された値に設定します。

status

VDS_PORT_STATUS

VDS_PORT_STATUS 列挙体によって列挙される値です。VDS_PRS_UNKNOWN を渡すと、E_INVALIDARG で失敗します。

戻り値

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IVdsControllerPort "{18691D0D-4E7F-43E8-92E4-CF44BEEED11C}"
#usecom global IVdsControllerPort IID_IVdsControllerPort "{}"
#comfunc global IVdsControllerPort_GetProperties        3 var
#comfunc global IVdsControllerPort_GetController        4 sptr
#comfunc global IVdsControllerPort_QueryAssociatedLuns  5 sptr
#comfunc global IVdsControllerPort_Reset                6
#comfunc global IVdsControllerPort_SetStatus            7 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IVdsControllerPort "{18691D0D-4E7F-43E8-92E4-CF44BEEED11C}"
#usecom global IVdsControllerPort IID_IVdsControllerPort "{}"
#comfunc global IVdsControllerPort_GetProperties        3 sptr
#comfunc global IVdsControllerPort_GetController        4 sptr
#comfunc global IVdsControllerPort_QueryAssociatedLuns  5 sptr
#comfunc global IVdsControllerPort_Reset                6
#comfunc global IVdsControllerPort_SetStatus            7 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。