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

IFsrmReport

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDd8cc81d9-46b8-4fa4-bfa5-4aa9dec9b638継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

単一のレポートの説明とフィルターを構成するために使用します。

メソッド 9

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_Type(FsrmReportType* reportType)

生成するレポートの種類を取得します。

reportTypeFsrmReportType*outこのレポートの種類を示す FsrmReportType 列挙値を受け取るポインタである。
vtbl 8 HRESULT get_Name(LPWSTR* name)

レポートの名前を取得または設定します。(Get)

nameLPWSTR*outレポートの名前を受け取る文字列ポインタである。

解説(Remarks)

設定されていない場合、FSRM が一意の名前を自動的に生成します。

名前はレポート内で使用されます。 電子メール通知が送信される場合、件名にレポート名が含まれます。

例

例については、 Adding a Report to a Job を参照してください。

vtbl 9 HRESULT put_Name(LPWSTR name)

レポートの名前を取得または設定します。(Put)

nameLPWSTRinレポートに設定する名前を指定する文字列である。

解説(Remarks)

設定されていない場合、FSRM が一意の名前を自動的に生成します。

名前はレポート内で使用されます。 電子メール通知が送信される場合、件名にレポート名が含まれます。

例

例については、 Adding a Report to a Job を参照してください。

vtbl 10 HRESULT get_Description(LPWSTR* description)

レポートの説明を取得または設定します。(Get)

descriptionLPWSTR*outレポートの説明文を受け取る文字列ポインタである。

解説(Remarks)

説明はレポート内で使用されます。

例

例については、 Adding a Report to a Job を参照してください。

vtbl 11 HRESULT put_Description(LPWSTR description)

レポートの説明を取得または設定します。(Put)

descriptionLPWSTRinレポートに設定する説明文を指定する文字列である。

解説(Remarks)

説明はレポート内で使用されます。

例

例については、 Adding a Report to a Job を参照してください。

vtbl 12 HRESULT get_LastGeneratedFileNamePrefix(LPWSTR* prefix)

レポートが最後に実行されたときに生成されたファイル名を取得します。

prefixLPWSTR*out最後に生成されたレポートファイル名のプレフィックスを受け取る文字列ポインタである。

解説(Remarks)

これらのファイル名は、レポートジョブが最後に実行されたときに、そのレポートジョブ用に生成された一連のファイルを識別するために生成されます。

レポートの保存先を確認するには、IFsrmReportJob::LastGeneratedInDirectory プロパティにアクセスしてください。

vtbl 13 HRESULT GetFilter(FsrmReportFilter filter, VARIANT* filterValue)

指定したレポートフィルターの値を取得します。

filterFsrmReportFilterinレポートに一覧表示されるファイルを制限するために使用するフィルター。指定可能な値については、FsrmReportFilter 列挙型を参照してください。
filterValueVARIANT*out指定したレポートフィルターに設定されているフィルター値。

戻り値

このメソッドは次の戻り値を返します。

vtbl 14 HRESULT SetFilter(FsrmReportFilter filter, VARIANT filterValue)

指定したレポートフィルターの現在の値を設定します。

filterFsrmReportFilterinレポートに一覧表示されるファイルを制限するために使用するフィルター。指定可能な値については、 FsrmReportFilter 列挙型を参照してください。
filterValueVARIANTin指定したレポートフィルターに使用するフィルター値。フィルター値には次の文字を含めることはできません。 スラッシュ (/)、円記号 (\)、大なり記号 (>)、小なり記号 (<)、縦棒 (|)、二重引用符 (")、コロン (:)。

戻り値

このメソッドは次の戻り値を返します。

解説(Remarks)

このフィルター値は、 IFsrmReportManager::SetDefaultFilter メソッドを使用して設定された既定値を上書きします。

レポートの種類ごとに、サポートされるフィルターが決まっている点に注意してください。フィルターがそのレポートの種類に対して有効かどうかを確認するには、 IFsrmReportManager::IsFilterValidForReportType メソッドを呼び出してください。

次の一覧は、filter パラメーターに使用する FsrmReportFilter 列挙型の値と、それに対応するバリアント型を示しています。

フィルターの種類 バリアント型
FsrmReportFilter_FileGroups VT_BSTR | VT_ARRAY。バリアントの parray メンバーを設定します。
FsrmReportFilter_MinAgeDays VT_I4。バリアントの lVal メンバーを設定します。
FsrmReportFilter_MaxAgeDays VT_I4。バリアントの lVal メンバーを設定します。
FsrmReportFilter_MinQuotaUsage VT_I4。バリアントの lVal メンバーを設定します。
FsrmReportFilter_MinSize VT_I8。バリアントの llVal メンバーを設定します。
FsrmReportFilter_NamePattern VT_BSTR。バリアントの bstrVal メンバーを設定します。
FsrmReportFilter_Owners VT_BSTR | VT_ARRAY。バリアントの parray メンバーを設定します。
FsrmReportFilter_Property VT_BSTR。バリアントの bstrVal メンバーを設定します。

例

例については、 Adding a Report to a Job を参照してください。

vtbl 15 HRESULT Delete()

このレポートオブジェクトをレポートジョブオブジェクトから削除します。

戻り値

このメソッドは次の戻り値を返します。

解説(Remarks)

レポートは IFsrmReportJob::Commit メソッドを呼び出すまで実際には削除されない点に注意してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFsrmReport "{D8CC81D9-46B8-4FA4-BFA5-4AA9DEC9B638}"
#usecom global IFsrmReport IID_IFsrmReport "{}"
#comfunc global IFsrmReport_get_Type                         7 var
#comfunc global IFsrmReport_get_Name                         8 var
#comfunc global IFsrmReport_put_Name                         9 wstr
#comfunc global IFsrmReport_get_Description                  10 var
#comfunc global IFsrmReport_put_Description                  11 wstr
#comfunc global IFsrmReport_get_LastGeneratedFileNamePrefix  12 var
#comfunc global IFsrmReport_GetFilter                        13 int,var
#comfunc global IFsrmReport_SetFilter                        14 int,int
#comfunc global IFsrmReport_Delete                           15
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。