ホーム › Devices.PortableDevices › IPortableDeviceProperties

IPortableDeviceProperties

COM

📘 Microsoft Learn (日本語) · English

IID7f6d695c-03df-4439-a809-59266beee3a6継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IPortableDeviceProperties インターフェイスは、デバイス上のオブジェクト、またはデバイス自体からプロパティを取得、追加、削除します。

メソッド 6

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

vtbl 3 HRESULT GetSupportedProperties(LPWSTR pszObjectID, IPortableDeviceKeyCollection** ppKeys)

GetSupportedProperties メソッドは、指定したオブジェクトがサポートするプロパティの一覧を取得します。これらのプロパティのすべてが実際に値を持つとは限らない点に注意してください。

pszObjectID	LPWSTR	in	照会対象のオブジェクトのオブジェクト ID を格納した、null 終端文字列へのポインターです。デバイス自体を指定するには WPD_DEVICE_OBJECT_ID を使用します。
ppKeys	IPortableDeviceKeyCollection**	out	サポートされるプロパティを格納した IPortableDeviceKeyCollection インターフェイスへのポインターを受け取る変数のアドレスです。Windows Portable Devices が定義するプロパティの一覧については、Properties and Attributes を参照してください。呼び出し側は、使用を終えたらこのインターフェイスを解放する必要があります。

戻り値

このメソッドは HRESULT を返します。戻り値には、次の表に示すものを含みますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。

解説(Remarks)

サポートされるプロパティの値を取得するには、GetPropertyAttributes を呼び出します。

vtbl 4 HRESULT GetPropertyAttributes(LPWSTR pszObjectID, PROPERTYKEY* Key, IPortableDeviceValues** ppAttributes)

GetPropertyAttributes メソッドは、デバイス上の指定したオブジェクトプロパティの属性を取得します。

pszObjectID	LPWSTR	in	照会対象のオブジェクトのオブジェクト ID を格納した、null 終端文字列へのポインターです。デバイス自体を指定するには WPD_DEVICE_OBJECT_ID を使用します。
Key	PROPERTYKEY*	in	照会するプロパティを指定する REFPROPERTYKEY です。サポートされるプロパティの一覧は、GetSupportedProperties を呼び出して取得できます。Windows Portable Devices が定義するプロパティの一覧については、Properties and Attributes を参照してください。
ppAttributes	IPortableDeviceValues**	out	取得したプロパティ属性を保持する IPortableDeviceValues インターフェイスへのポインターを受け取る変数のアドレスです。属性は PROPERTYKEY と値のペアであり、PROPERTYKEY がプロパティを表し、値のデータ型は個々のプロパティによって異なります。呼び出し側は、使用を終えたらこのインターフェイスを解放する必要があります。Windows Portable Devices が定義する属性については、Properties and Attributes のページを参照してください。

戻り値

このメソッドは HRESULT を返します。戻り値には、次の表に示すものを含みますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功し、すべての属性が正常に取得されました。
S_FALSE	一部の属性値のみ取得できました。取得できなかった属性は、VT_ERROR 型の HRESULT 値を格納します。
E_POINTER	必須のポインター引数が NULL でした。

解説(Remarks)

プロパティ属性は、そのプロパティのアクセス権、有効な値、その他の情報を示します。たとえば、あるプロパティは削除を防ぐために WPD_PROPERTY_ATTRIBUTE_CAN_DELETE の値が False に設定されていたり、有効な値の範囲が個々のエントリとして格納されていたりします。

例

このメソッドの使用例については、Setting Properties for a Single Object を参照してください。

vtbl 5 HRESULT GetValues(LPWSTR pszObjectID, IPortableDeviceKeyCollection* pKeys, IPortableDeviceValues** ppValues)

GetValues メソッドは、デバイス上の指定したオブジェクトから、指定したプロパティの一覧を取得します。

pszObjectID	LPWSTR	in	照会対象のオブジェクトの ID を格納した、null 終端文字列へのポインターです。デバイス自体を指定するには WPD_DEVICE_OBJECT_ID を使用します。
pKeys	IPortableDeviceKeyCollection*	in	照会する 1 つ以上のプロパティを格納した IPortableDeviceKeyCollection インターフェイスへのポインターです。これが NULL の場合は、すべてのプロパティが取得されます。Windows Portable Devices が定義するプロパティの一覧については、Properties and Attributes を参照してください。
ppValues	IPortableDeviceValues**	out	要求したプロパティ値を格納した IPortableDeviceValues インターフェイスへのポインターを受け取る変数のアドレスです。値は PROPERTYKEY と値のペアとして返され、値のデータ型はプロパティによって異なります。何らかの理由で値を取得できなかった場合、返される型は VT_ERROR となり、取得エラーを示す HRESULT 値が格納されます。呼び出し側は、使用を終えたらこのインターフェイスを解放する必要があります。

戻り値

このメソッドは HRESULT を返します。戻り値には、次の表に示すものを含みますが、これらに限定されません。

戻り値	説明
S_OK	要求されたすべてのプロパティ値が取得されました。
S_FALSE	1 つ以上のプロパティ値を取得できませんでした。問題のあるプロパティは、取得された ppValues パラメーター内に HRESULT 値を持ちます。

vtbl 6 HRESULT SetValues(LPWSTR pszObjectID, IPortableDeviceValues* pValues, IPortableDeviceValues** ppResults)

SetValues メソッドは、デバイス上の指定したオブジェクトに対して 1 つ以上のプロパティを追加または変更します。

pszObjectID	LPWSTR	in	変更対象のオブジェクトのオブジェクト ID を格納した、null 終端文字列へのポインターです。デバイス自体を指定するには WPD_DEVICE_OBJECT_ID を使用します。
pValues	IPortableDeviceValues*	in	設定する 1 つ以上のプロパティと値のペアを格納した IPortableDeviceValues インターフェイスへのポインターです。既存の値は上書きされます。
ppResults	IPortableDeviceValues**	out	プロパティと HRESULT 値のコレクションを格納した IPortableDeviceValues インターフェイスへのポインターを受け取る変数のアドレスです。各値 (VT_ERROR 型) は、プロパティ設定の成否を示します。呼び出し側は、使用を終えたらこのインターフェイスを解放する必要があります。

戻り値

このメソッドは HRESULT を返します。戻り値には、次の表に示すものを含みますが、これらに限定されません。

戻り値	説明
S_OK	指定されたすべてのプロパティ値が更新されました。
S_FALSE	1 つ以上のプロパティを変更できませんでした。変更できなかったプロパティは、取得された ppResults パラメーター内に VT_ERROR 型の HRESULT を持ちます。

解説(Remarks)

プロパティを削除するには、IPortableDeviceProperties::Delete を呼び出します。プロパティを削除できるのは、その WPD_PROPERTY_ATTRIBUTE_CAN_WRITE 属性が True の場合のみです。この属性は GetPropertyAttributes を呼び出して取得できます。

例

このメソッドの使用例については、Setting Properties for a Single Object を参照してください。

vtbl 7 HRESULT Delete(LPWSTR pszObjectID, IPortableDeviceKeyCollection* pKeys)

Delete メソッドは、デバイス上の指定したオブジェクトから、指定したプロパティを削除します。

pszObjectID	LPWSTR	in	プロパティを削除する対象のオブジェクトの ID を指定する、null 終端文字列へのポインターです。デバイス自体を指定するには WPD_DEVICE_OBJECT_ID を使用します。
pKeys	IPortableDeviceKeyCollection*	in	削除するプロパティを指定する IPortableDeviceKeyCollection インターフェイスへのポインターです。Windows Portable Devices が定義するプロパティの一覧については、Properties and Attributes を参照してください。

戻り値

このメソッドは HRESULT を返します。戻り値には、次の表に示すものを含みますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。
S_FALSE	1 つ以上のプロパティ値を削除できませんでした。
E_POINTER	必須のポインター引数が NULL でした。

解説(Remarks)

プロパティを削除できるのは、その WPD_PROPERTY_ATTRIBUTE_CAN_DELETE 属性が True の場合のみです。この属性は GetPropertyAttributes を呼び出して取得できます。

ドライバーには部分的な成功を示す手段がありません。つまり、一部のプロパティしか削除できなかった場合、ドライバーは S_FALSE を返しますが、このメソッドはどのプロパティが正常に削除されたかを示しません。削除されたプロパティを知る唯一の方法は、IPortableDeviceProperties::GetValues を呼び出してすべてのプロパティを要求することです。

vtbl 8 HRESULT Cancel()

Cancel メソッドは、保留中の呼び出しをキャンセルします。

戻り値

このメソッドは HRESULT を返します。戻り値には、次の表に示すものを含みますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。

解説(Remarks)

このメソッドは、現在のデバイスハンドル (IPortableDevice インターフェイスに関連付けられたセッションに対応します) 上の保留中の操作をすべてキャンセルします。Windows Portable Devices (WPD) API は、特定の操作のみを対象としたキャンセルをサポートしていません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IPortableDeviceProperties "{7F6D695C-03DF-4439-A809-59266BEEE3A6}"
#usecom global IPortableDeviceProperties IID_IPortableDeviceProperties "{}"
#comfunc global IPortableDeviceProperties_GetSupportedProperties  3 wstr,sptr
#comfunc global IPortableDeviceProperties_GetPropertyAttributes   4 wstr,var,sptr
#comfunc global IPortableDeviceProperties_GetValues               5 wstr,sptr,sptr
#comfunc global IPortableDeviceProperties_SetValues               6 wstr,sptr,sptr
#comfunc global IPortableDeviceProperties_Delete                  7 wstr,sptr
#comfunc global IPortableDeviceProperties_Cancel                  8
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IPortableDeviceProperties "{7F6D695C-03DF-4439-A809-59266BEEE3A6}"
#usecom global IPortableDeviceProperties IID_IPortableDeviceProperties "{}"
#comfunc global IPortableDeviceProperties_GetSupportedProperties  3 wstr,sptr
#comfunc global IPortableDeviceProperties_GetPropertyAttributes   4 wstr,sptr,sptr
#comfunc global IPortableDeviceProperties_GetValues               5 wstr,sptr,sptr
#comfunc global IPortableDeviceProperties_SetValues               6 wstr,sptr,sptr
#comfunc global IPortableDeviceProperties_Delete                  7 wstr,sptr
#comfunc global IPortableDeviceProperties_Cancel                  8
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。