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

IFhTarget

COM
📘 Microsoft Learn (日本語) · English
IIDd87965fd-2bad-4657-bd3b-9567eb300ced継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IFhTarget インターフェイスを使用すると、クライアント アプリケーションはファイル履歴のバックアップ ターゲットの数値プロパティおよび文字列プロパティを読み取ることができます。

メソッド 2

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

vtbl 3 HRESULT GetStringProperty(FH_TARGET_PROPERTY_TYPE PropertyType, LPWSTR* PropertyValue)

IFhTarget インターフェイスによって表されるファイル履歴のバックアップ ターゲットの文字列プロパティを取得します。

PropertyTypeFH_TARGET_PROPERTY_TYPEin文字列プロパティを指定します。指定可能な文字列プロパティの種類の一覧については、FH_TARGET_PROPERTY_TYPE 列挙型を参照してください。
PropertyValueLPWSTR*outこのパラメーターは入力時に NULL である必要があります。出力時には、文字列プロパティを格納した文字列へのポインターを受け取ります。この文字列は SysAllocString を呼び出して割り当てられます。不要になった時点で SysFreeString を呼び出して文字列を解放する必要があります。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は、FhErrors.h ヘッダー ファイルで定義されている値などの HRESULT エラー コードを返します。

解説(Remarks)

FH_TARGET_PROPERTY_TYPE 列挙型は、文字列プロパティと数値プロパティの両方のプロパティの種類を定義します。ただし、IFhTarget::GetStringProperty メソッドで取得できるのは文字列プロパティのみです。数値プロパティは IFhTarget::GetNumericalProperty メソッドを呼び出して取得する必要があります。

vtbl 4 HRESULT GetNumericalProperty(FH_TARGET_PROPERTY_TYPE PropertyType, ULONGLONG* PropertyValue)

IFhTarget インターフェイスによって表されるファイル履歴のバックアップ ターゲットの数値プロパティを取得します。

PropertyTypeFH_TARGET_PROPERTY_TYPEin数値プロパティを指定します。指定可能な数値プロパティの一覧については、FH_TARGET_PROPERTY_TYPE 列挙型を参照してください。
PropertyValueULONGLONG*out数値プロパティの値を受け取ります。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は、FhErrors.h ヘッダー ファイルで定義されている値などの HRESULT エラー コードを返します。

解説(Remarks)

FH_TARGET_PROPERTY_TYPE 列挙型は、文字列プロパティと数値プロパティの両方のプロパティの種類を定義します。ただし、IFhTarget::GetNumericalProperty メソッドで取得できるのは数値プロパティのみです。文字列プロパティは IFhTarget::GetStringProperty メソッドを呼び出して取得する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFhTarget "{D87965FD-2BAD-4657-BD3B-9567EB300CED}"
#usecom global IFhTarget IID_IFhTarget "{}"
#comfunc global IFhTarget_GetStringProperty     3 int,var
#comfunc global IFhTarget_GetNumericalProperty  4 int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。