ホーム › Storage.FileServerResourceManager › IFsrmReportScheduler

IFsrmReportScheduler

COMIDispatch (デュアル)

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID6879caf9-6617-4484-8719-71c3d8645f94継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

レポートジョブおよびファイル管理ジョブのスケジュール済みタスクを管理するために使用します。

解説(Remarks)

レポートのスケジュールを列挙するには、 IFsrmReportManager::EnumReportJobs メソッドを呼び出します。 IFsrmReportJob::Task プロパティのタスク名を使用して、タスクスケジューラからスケジュールを取得します。スケジュールを取得するには、 ITaskScheduler::Activate メソッドを呼び出します。 (FSRM がサポートするのはタスクスケジューラバージョン 1.0 のみで、バージョン 2.0 はサポートされません。) なお、レポートジョブによっては、関連付けられたスケジュールが存在しない場合があります。

ファイル管理ジョブのスケジュールを列挙するには、 IFsrmFileManagementJobManager::EnumFileManagementJobs メソッドを呼び出します。 IFsrmFileManagementJob::Task プロパティのタスク名を使用して、タスクスケジューラからスケジュールを取得します。スケジュールを取得するには、ITaskScheduler::Activate メソッドを呼び出します。

スクリプトからこのオブジェクトを作成するには、"Fsrm.FsrmReportScheduler" というプログラム識別子を使用します。

メソッド 4

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

vtbl 7 HRESULT VerifyNamespaces(VARIANT* namespacesSafeArray)

レポートのソースとして使用される、指定されたローカルディレクトリパスが有効かどうかを検証します。

namespacesSafeArray

VARIANT*

ローカルディレクトリパスの SAFEARRAY を格納する VARIANT。配列の各要素は VT_BSTR 型のバリアントです。バリアントの bstrVal メンバーを使用してパスを設定します。

戻り値

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

解説(Remarks)

パスが有効であれば、 IFsrmReportScheduler::CreateScheduleTask メソッドを呼び出す際にそれらのパスを使用できます。

パスが有効となるのは、次の条件を満たす場合です。

配列内のすべてのパスが NTFS ボリューム上にある。
配列内のすべてのパスが、オンラインでアクセス可能なボリューム上にある。
クラスターの場合、すべてのパスが同一のフェールオーバーグループ内のボリューム上にある。

いずれかのパスの検証に失敗した場合、どのパスが失敗したかは示されません。失敗したパスを特定するには、パスごとに個別にこのメソッドを呼び出す必要があります。クラスターの場合、すべてのパスの検証に成功したときは、クラスター API を使用してクラスターグループを確認する必要があります。

vtbl 8 HRESULT CreateScheduleTask(LPWSTR taskName, VARIANT* namespacesSafeArray, LPWSTR serializedTask)

レポートジョブをトリガーするために使用するスケジュール済みタスクを作成します。

taskName	LPWSTR	in	作成するタスクスケジューラタスクの名前。文字列は 230 文字までに制限されます。
namespacesSafeArray	VARIANT*	in	検証対象のローカルディレクトリパスの SAFEARRAY を格納する VARIANT (「解説」を参照)。配列の各要素は VT_BSTR 型のバリアントです。バリアントの bstrVal メンバーを使用してパスを設定します。
serializedTask	LPWSTR	in	タスクスケジューラのジョブを定義する XML 文字列。詳細については、タスクスケジューラスキーマを参照してください。

戻り値

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

解説(Remarks)

レポートジョブをスケジュールに従って実行するには、taskName パラメーターの値と IFsrmReportJob::Task プロパティの値が同一である必要があります。

このメソッドには、 IFsrmReportJob::NamespaceRoots プロパティに指定したものと同じ名前空間を指定してください。このメソッドは名前空間パスを検証します。検証の詳細については、 VerifyNamespaces の「解説」セクションを参照してください。

XML を生成するには、タスクスケジューラ v2.0 のインターフェイスを使用してスケジュール済みタスクを定義できます。ただし、タスク定義は v1.0 互換である必要があります。(タスクの定義には Task Scheduler API を使用しますが、タスクの登録には使用しません。登録はこのメソッドが行います。) タスクを定義した後、 ITaskDefinition::XmlText プロパティにアクセスして XML を取得します。

なお、FSRM は、XML に含まれるサポート対象外のトリガーを無視します。"MONTHLYDOW" トリガーでは、V2 拡張は使用できません。たとえば、"WeeksOfMonth" を指定する場合、指定できるのは月内の 1 週のみであり、第 5 週は指定できません。また、"DaysOfWeek" では 1 日のみ指定できます。

例

例については、レポートジョブのスケジュール設定を参照してください。

vtbl 9 HRESULT ModifyScheduleTask(LPWSTR taskName, VARIANT* namespacesSafeArray, LPWSTR serializedTask)

レポートジョブをトリガーするために使用するタスクを変更します。

taskName	LPWSTR	in	変更するタスクスケジューラタスクの名前。文字列は 230 文字までに制限されます。
namespacesSafeArray	VARIANT*	in	検証対象のローカルディレクトリパスの SAFEARRAY を格納する VARIANT (「解説」を参照)。配列の各要素は VT_BSTR 型のバリアントです。バリアントの bstrVal メンバーを使用してパスを設定します。
serializedTask	LPWSTR	in	タスクスケジューラのジョブを定義する XML 文字列。詳細については、タスクスケジューラスキーマを参照してください。

戻り値

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

解説(Remarks)

このメソッドには、 IFsrmReportJob::NamespaceRoots プロパティに指定したものと同じ名前空間を指定してください。このメソッドは名前空間パスを検証します。検証の詳細については、 IFsrmReportScheduler::VerifyNamespaces の「解説」セクションを参照してください。

vtbl 10 HRESULT DeleteScheduleTask(LPWSTR taskName)

レポートジョブをトリガーするために使用するタスクを削除します。

taskName

LPWSTR

削除するタスクスケジューラタスクの名前。文字列は 230 文字までに制限されます。

戻り値

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFsrmReportScheduler "{6879CAF9-6617-4484-8719-71C3D8645F94}"
#usecom global IFsrmReportScheduler IID_IFsrmReportScheduler "{EA25F1B8-1B8D-4290-8EE8-E17C12C2FE20}"
#comfunc global IFsrmReportScheduler_VerifyNamespaces    7 var
#comfunc global IFsrmReportScheduler_CreateScheduleTask  8 wstr,var,wstr
#comfunc global IFsrmReportScheduler_ModifyScheduleTask  9 wstr,var,wstr
#comfunc global IFsrmReportScheduler_DeleteScheduleTask  10 wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IFsrmReportScheduler "{6879CAF9-6617-4484-8719-71C3D8645F94}"
#usecom global IFsrmReportScheduler IID_IFsrmReportScheduler "{EA25F1B8-1B8D-4290-8EE8-E17C12C2FE20}"
#comfunc global IFsrmReportScheduler_VerifyNamespaces    7 sptr
#comfunc global IFsrmReportScheduler_CreateScheduleTask  8 wstr,sptr,wstr
#comfunc global IFsrmReportScheduler_ModifyScheduleTask  9 wstr,sptr,wstr
#comfunc global IFsrmReportScheduler_DeleteScheduleTask  10 wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。