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

IFsrmReportJob

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID38e87280-715c-4c7d-a280-ea1651a19fef継承元IFsrmObject呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl12

メソッド 17

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

vtbl 12 HRESULT get_Task(LPWSTR* taskName)
taskNameLPWSTR*outこのレポートジョブに関連付けられたスケジュールタスクの名前を受け取る文字列ポインタである。
vtbl 13 HRESULT put_Task(LPWSTR taskName)
taskNameLPWSTRinこのレポートジョブに関連付けるスケジュールタスクの名前を指定する文字列である。
vtbl 14 HRESULT get_NamespaceRoots(SAFEARRAY** namespaceRoots)
namespaceRootsSAFEARRAY**outレポート対象とする名前空間ルート (ディレクトリパス) の一覧を格納した SAFEARRAY を受け取るポインタである。
vtbl 15 HRESULT put_NamespaceRoots(SAFEARRAY* namespaceRoots)
namespaceRootsSAFEARRAY*inレポート対象として設定する名前空間ルート (ディレクトリパス) の一覧を格納した SAFEARRAY を指定する。
vtbl 16 HRESULT get_Formats(SAFEARRAY** formats)
formatsSAFEARRAY**outレポートの出力形式の一覧を格納した SAFEARRAY を受け取るポインタである。
vtbl 17 HRESULT put_Formats(SAFEARRAY* formats)
formatsSAFEARRAY*inレポートの出力形式として設定する一覧を格納した SAFEARRAY を指定する。
vtbl 18 HRESULT get_MailTo(LPWSTR* mailTo)
mailToLPWSTR*outレポートの送信先メールアドレスを受け取る文字列ポインタである。
vtbl 19 HRESULT put_MailTo(LPWSTR mailTo)
mailToLPWSTRinレポートの送信先として設定するメールアドレスを指定する文字列である。
vtbl 20 HRESULT get_RunningStatus(FsrmReportRunningStatus* runningStatus)
runningStatusFsrmReportRunningStatus*outレポートジョブの現在の実行状態を示す FsrmReportRunningStatus 列挙値を受け取るポインタである。
vtbl 21 HRESULT get_LastRun(DOUBLE* lastRun)
lastRunDOUBLE*outレポートジョブが最後に実行された日時を表す DOUBLE 値 (DATE 形式) を受け取るポインタである。
vtbl 22 HRESULT get_LastError(LPWSTR* lastError)
lastErrorLPWSTR*outレポートジョブの最後の実行で発生したエラーメッセージを受け取る文字列ポインタである。
vtbl 23 HRESULT get_LastGeneratedInDirectory(LPWSTR* path)
pathLPWSTR*out最後にレポートが生成されたディレクトリのパスを受け取る文字列ポインタである。
vtbl 24 HRESULT EnumReports(IFsrmCollection** reports)
reportsIFsrmCollection**outこのレポートジョブに含まれるレポートを格納するコレクション IFsrmCollection を受け取るポインタである。
vtbl 25 HRESULT CreateReport(FsrmReportType reportType, IFsrmReport** report)
reportTypeFsrmReportTypein作成するレポートの種類を示す FsrmReportType 列挙値を指定する。
reportIFsrmReport**out新規に作成されたレポートの IFsrmReport インターフェイスを受け取るポインタである。
vtbl 26 HRESULT Run(FsrmReportGenerationContext context)
contextFsrmReportGenerationContextinレポートジョブを実行する際の生成コンテキストを示す FsrmReportGenerationContext 列挙値を指定する。
vtbl 27 HRESULT WaitForCompletion(INT waitSeconds, VARIANT_BOOL* completed)
waitSecondsINTin完了を待機する最大秒数を指定する。0 は待機なし、負の値は無制限の待機を意味する。
completedVARIANT_BOOL*out待機時間内にレポートジョブが完了したかどうかを示す VARIANT_BOOL を受け取るポインタである。
vtbl 28 HRESULT Cancel()

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

出力引数:
#define global IID_IFsrmReportJob "{38E87280-715C-4C7D-A280-EA1651A19FEF}"
#usecom global IFsrmReportJob IID_IFsrmReportJob "{}"
#comfunc global IFsrmReportJob_get_Task                      12 var
#comfunc global IFsrmReportJob_put_Task                      13 wstr
#comfunc global IFsrmReportJob_get_NamespaceRoots            14 var
#comfunc global IFsrmReportJob_put_NamespaceRoots            15 var
#comfunc global IFsrmReportJob_get_Formats                   16 var
#comfunc global IFsrmReportJob_put_Formats                   17 var
#comfunc global IFsrmReportJob_get_MailTo                    18 var
#comfunc global IFsrmReportJob_put_MailTo                    19 wstr
#comfunc global IFsrmReportJob_get_RunningStatus             20 var
#comfunc global IFsrmReportJob_get_LastRun                   21 var
#comfunc global IFsrmReportJob_get_LastError                 22 var
#comfunc global IFsrmReportJob_get_LastGeneratedInDirectory  23 var
#comfunc global IFsrmReportJob_EnumReports                   24 sptr
#comfunc global IFsrmReportJob_CreateReport                  25 int,sptr
#comfunc global IFsrmReportJob_Run                           26 int
#comfunc global IFsrmReportJob_WaitForCompletion             27 int,var
#comfunc global IFsrmReportJob_Cancel                        28
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。