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

IFsrmFileManagementJob

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

メソッド 49

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

vtbl 12 HRESULT get_Name(LPWSTR* name)
nameLPWSTR*outファイル管理ジョブの名前を受け取る文字列ポインタである。
vtbl 13 HRESULT put_Name(LPWSTR name)
nameLPWSTRinファイル管理ジョブに設定する名前を指定する文字列である。
vtbl 14 HRESULT get_NamespaceRoots(SAFEARRAY** namespaceRoots)
namespaceRootsSAFEARRAY**outジョブの処理対象とする名前空間ルート (ディレクトリパス) の一覧を格納した SAFEARRAY を受け取るポインタである。
vtbl 15 HRESULT put_NamespaceRoots(SAFEARRAY* namespaceRoots)
namespaceRootsSAFEARRAY*inジョブの処理対象として設定する名前空間ルート (ディレクトリパス) の一覧を格納した SAFEARRAY を指定する。
vtbl 16 HRESULT get_Enabled(VARIANT_BOOL* enabled)
enabledVARIANT_BOOL*outファイル管理ジョブが有効かどうかを示す VARIANT_BOOL を受け取るポインタである。
vtbl 17 HRESULT put_Enabled(VARIANT_BOOL enabled)
enabledVARIANT_BOOLinファイル管理ジョブを有効にするかどうかを指定する VARIANT_BOOL である。
vtbl 18 HRESULT get_OperationType(FsrmFileManagementType* operationType)
operationTypeFsrmFileManagementType*outジョブが実行する操作の種類を示す FsrmFileManagementType 列挙値を受け取るポインタである。
vtbl 19 HRESULT put_OperationType(FsrmFileManagementType operationType)
operationTypeFsrmFileManagementTypeinジョブが実行する操作の種類として設定する FsrmFileManagementType 列挙値を指定する。
vtbl 20 HRESULT get_ExpirationDirectory(LPWSTR* expirationDirectory)
expirationDirectoryLPWSTR*outファイルの有効期限切れ時に対象ファイルを移動する先のディレクトリのパスを受け取る文字列ポインタである。
vtbl 21 HRESULT put_ExpirationDirectory(LPWSTR expirationDirectory)
expirationDirectoryLPWSTRinファイルの有効期限切れ時に対象ファイルを移動する先のディレクトリのパスを指定する文字列である。
vtbl 22 HRESULT get_CustomAction(IFsrmActionCommand** action)
actionIFsrmActionCommand**outジョブに関連付けられたカスタムアクション (実行コマンド) を表す IFsrmActionCommand インターフェイスを受け取るポインタである。
vtbl 23 HRESULT get_Notifications(SAFEARRAY** notifications)
notificationsSAFEARRAY**outジョブに設定された通知期間の一覧を表す IFsrmActionType 通知オブジェクトを格納した SAFEARRAY を受け取るポインタである。
vtbl 24 HRESULT get_Logging(INT* loggingFlags)
loggingFlagsINT*outジョブのログ記録動作を制御するフラグの組み合わせを受け取るポインタである。
vtbl 25 HRESULT put_Logging(INT loggingFlags)
loggingFlagsINTinジョブのログ記録動作を制御するフラグの組み合わせを指定する。
vtbl 26 HRESULT get_ReportEnabled(VARIANT_BOOL* reportEnabled)
reportEnabledVARIANT_BOOL*outジョブのレポート生成が有効かどうかを示す VARIANT_BOOL を受け取るポインタである。
vtbl 27 HRESULT put_ReportEnabled(VARIANT_BOOL reportEnabled)
reportEnabledVARIANT_BOOLinジョブのレポート生成を有効にするかどうかを指定する VARIANT_BOOL である。
vtbl 28 HRESULT get_Formats(SAFEARRAY** formats)
formatsSAFEARRAY**outジョブが生成するレポートの出力形式の一覧を格納した SAFEARRAY を受け取るポインタである。
vtbl 29 HRESULT put_Formats(SAFEARRAY* formats)
formatsSAFEARRAY*inジョブが生成するレポートの出力形式として設定する一覧を格納した SAFEARRAY を指定する。
vtbl 30 HRESULT get_MailTo(LPWSTR* mailTo)
mailToLPWSTR*outジョブのレポートの送信先メールアドレスを受け取る文字列ポインタである。
vtbl 31 HRESULT put_MailTo(LPWSTR mailTo)
mailToLPWSTRinジョブのレポートの送信先として設定するメールアドレスを指定する文字列である。
vtbl 32 HRESULT get_DaysSinceFileCreated(INT* daysSinceCreation)
daysSinceCreationINT*outファイル作成からの経過日数の条件値を受け取るポインタである。
vtbl 33 HRESULT put_DaysSinceFileCreated(INT daysSinceCreation)
daysSinceCreationINTinジョブの処理対象とするファイル作成からの経過日数の条件値を指定する。
vtbl 34 HRESULT get_DaysSinceFileLastAccessed(INT* daysSinceAccess)
daysSinceAccessINT*outファイルの最終アクセスからの経過日数の条件値を受け取るポインタである。
vtbl 35 HRESULT put_DaysSinceFileLastAccessed(INT daysSinceAccess)
daysSinceAccessINTinジョブの処理対象とするファイルの最終アクセスからの経過日数の条件値を指定する。
vtbl 36 HRESULT get_DaysSinceFileLastModified(INT* daysSinceModify)
daysSinceModifyINT*outファイルの最終更新からの経過日数の条件値を受け取るポインタである。
vtbl 37 HRESULT put_DaysSinceFileLastModified(INT daysSinceModify)
daysSinceModifyINTinジョブの処理対象とするファイルの最終更新からの経過日数の条件値を指定する。
vtbl 38 HRESULT get_PropertyConditions(IFsrmCollection** propertyConditions)
propertyConditionsIFsrmCollection**outジョブの処理対象を絞り込むプロパティ条件の集合を格納するコレクション IFsrmCollection を受け取るポインタである。
vtbl 39 HRESULT get_FromDate(DOUBLE* fromDate)
fromDateDOUBLE*outジョブの対象期間の起点となる日時を表す DOUBLE 値 (DATE 形式) を受け取るポインタである。
vtbl 40 HRESULT put_FromDate(DOUBLE fromDate)
fromDateDOUBLEinジョブの対象期間の起点となる日時を表す DOUBLE 値 (DATE 形式) を指定する。
vtbl 41 HRESULT get_Task(LPWSTR* taskName)
taskNameLPWSTR*outジョブに関連付けられたスケジュールタスクの名前を受け取る文字列ポインタである。
vtbl 42 HRESULT put_Task(LPWSTR taskName)
taskNameLPWSTRinジョブに関連付けるスケジュールタスクの名前を指定する文字列である。
vtbl 43 HRESULT get_Parameters(SAFEARRAY** parameters)
parametersSAFEARRAY**outジョブに渡されるパラメータ (名前=値 の文字列) の一覧を格納した SAFEARRAY を受け取るポインタである。
vtbl 44 HRESULT put_Parameters(SAFEARRAY* parameters)
parametersSAFEARRAY*inジョブに設定するパラメータ (名前=値 の文字列) の一覧を格納した SAFEARRAY を指定する。
vtbl 45 HRESULT get_RunningStatus(FsrmReportRunningStatus* runningStatus)
runningStatusFsrmReportRunningStatus*outジョブの現在の実行状態を示す FsrmReportRunningStatus 列挙値を受け取るポインタである。
vtbl 46 HRESULT get_LastError(LPWSTR* lastError)
lastErrorLPWSTR*outジョブの最後の実行で発生したエラーメッセージを受け取る文字列ポインタである。
vtbl 47 HRESULT get_LastReportPathWithoutExtension(LPWSTR* path)
pathLPWSTR*out最後に生成されたレポートの拡張子を除いたパスを受け取る文字列ポインタである。
vtbl 48 HRESULT get_LastRun(DOUBLE* lastRun)
lastRunDOUBLE*outジョブが最後に実行された日時を表す DOUBLE 値 (DATE 形式) を受け取るポインタである。
vtbl 49 HRESULT get_FileNamePattern(LPWSTR* fileNamePattern)
fileNamePatternLPWSTR*outジョブの処理対象を絞り込むファイル名のパターンを受け取る文字列ポインタである。
vtbl 50 HRESULT put_FileNamePattern(LPWSTR fileNamePattern)
fileNamePatternLPWSTRinジョブの処理対象を絞り込むファイル名のパターンを指定する文字列である。
vtbl 51 HRESULT Run(FsrmReportGenerationContext context)
contextFsrmReportGenerationContextinジョブを実行する際の生成コンテキストを示す FsrmReportGenerationContext 列挙値を指定する。
vtbl 52 HRESULT WaitForCompletion(INT waitSeconds, VARIANT_BOOL* completed)
waitSecondsINTin完了を待機する最大秒数を指定する。0 は待機なし、負の値は無制限の待機を意味する。
completedVARIANT_BOOL*out待機時間内にジョブが完了したかどうかを示す VARIANT_BOOL を受け取るポインタである。
vtbl 53 HRESULT Cancel()
vtbl 54 HRESULT AddNotification(INT days)
daysINTin通知を発行するまでの日数を指定する。
vtbl 55 HRESULT DeleteNotification(INT days)
daysINTin削除対象の通知に対応する日数を指定する。
vtbl 56 HRESULT ModifyNotification(INT days, INT newDays)
daysINTin変更対象の既存の通知に対応する日数を指定する。
newDaysINTin通知に新たに設定する日数を指定する。
vtbl 57 HRESULT CreateNotificationAction(INT days, FsrmActionType actionType, IFsrmAction** action)
daysINTinアクションを関連付ける通知に対応する日数を指定する。
actionTypeFsrmActionTypein作成するアクションの種類を示す FsrmActionType 列挙値を指定する。
actionIFsrmAction**out新規に作成された通知アクションの IFsrmAction インターフェイスを受け取るポインタである。
vtbl 58 HRESULT EnumNotificationActions(INT days, IFsrmCollection** actions)
daysINTinアクションを列挙する対象の通知に対応する日数を指定する。
actionsIFsrmCollection**out指定した通知に関連付けられたアクションを格納するコレクション IFsrmCollection を受け取るポインタである。
vtbl 59 HRESULT CreatePropertyCondition(LPWSTR name, IFsrmPropertyCondition** propertyCondition)
nameLPWSTRin作成するプロパティ条件の対象となるプロパティ名を指定する文字列である。
propertyConditionIFsrmPropertyCondition**out新規に作成されたプロパティ条件の IFsrmPropertyCondition インターフェイスを受け取るポインタである。
vtbl 60 HRESULT CreateCustomAction(IFsrmActionCommand** customAction)
customActionIFsrmActionCommand**out新規に作成されたカスタムアクション (実行コマンド) の IFsrmActionCommand インターフェイスを受け取るポインタである。

HSP用 COM定義

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

出力引数:
#define global IID_IFsrmFileManagementJob "{0770687E-9F36-4D6F-8778-599D188461C9}"
#usecom global IFsrmFileManagementJob IID_IFsrmFileManagementJob "{}"
#comfunc global IFsrmFileManagementJob_get_Name                            12 var
#comfunc global IFsrmFileManagementJob_put_Name                            13 wstr
#comfunc global IFsrmFileManagementJob_get_NamespaceRoots                  14 var
#comfunc global IFsrmFileManagementJob_put_NamespaceRoots                  15 var
#comfunc global IFsrmFileManagementJob_get_Enabled                         16 var
#comfunc global IFsrmFileManagementJob_put_Enabled                         17 int
#comfunc global IFsrmFileManagementJob_get_OperationType                   18 var
#comfunc global IFsrmFileManagementJob_put_OperationType                   19 int
#comfunc global IFsrmFileManagementJob_get_ExpirationDirectory             20 var
#comfunc global IFsrmFileManagementJob_put_ExpirationDirectory             21 wstr
#comfunc global IFsrmFileManagementJob_get_CustomAction                    22 sptr
#comfunc global IFsrmFileManagementJob_get_Notifications                   23 var
#comfunc global IFsrmFileManagementJob_get_Logging                         24 var
#comfunc global IFsrmFileManagementJob_put_Logging                         25 int
#comfunc global IFsrmFileManagementJob_get_ReportEnabled                   26 var
#comfunc global IFsrmFileManagementJob_put_ReportEnabled                   27 int
#comfunc global IFsrmFileManagementJob_get_Formats                         28 var
#comfunc global IFsrmFileManagementJob_put_Formats                         29 var
#comfunc global IFsrmFileManagementJob_get_MailTo                          30 var
#comfunc global IFsrmFileManagementJob_put_MailTo                          31 wstr
#comfunc global IFsrmFileManagementJob_get_DaysSinceFileCreated            32 var
#comfunc global IFsrmFileManagementJob_put_DaysSinceFileCreated            33 int
#comfunc global IFsrmFileManagementJob_get_DaysSinceFileLastAccessed       34 var
#comfunc global IFsrmFileManagementJob_put_DaysSinceFileLastAccessed       35 int
#comfunc global IFsrmFileManagementJob_get_DaysSinceFileLastModified       36 var
#comfunc global IFsrmFileManagementJob_put_DaysSinceFileLastModified       37 int
#comfunc global IFsrmFileManagementJob_get_PropertyConditions              38 sptr
#comfunc global IFsrmFileManagementJob_get_FromDate                        39 var
#comfunc global IFsrmFileManagementJob_put_FromDate                        40 double
#comfunc global IFsrmFileManagementJob_get_Task                            41 var
#comfunc global IFsrmFileManagementJob_put_Task                            42 wstr
#comfunc global IFsrmFileManagementJob_get_Parameters                      43 var
#comfunc global IFsrmFileManagementJob_put_Parameters                      44 var
#comfunc global IFsrmFileManagementJob_get_RunningStatus                   45 var
#comfunc global IFsrmFileManagementJob_get_LastError                       46 var
#comfunc global IFsrmFileManagementJob_get_LastReportPathWithoutExtension  47 var
#comfunc global IFsrmFileManagementJob_get_LastRun                         48 var
#comfunc global IFsrmFileManagementJob_get_FileNamePattern                 49 var
#comfunc global IFsrmFileManagementJob_put_FileNamePattern                 50 wstr
#comfunc global IFsrmFileManagementJob_Run                                 51 int
#comfunc global IFsrmFileManagementJob_WaitForCompletion                   52 int,var
#comfunc global IFsrmFileManagementJob_Cancel                              53
#comfunc global IFsrmFileManagementJob_AddNotification                     54 int
#comfunc global IFsrmFileManagementJob_DeleteNotification                  55 int
#comfunc global IFsrmFileManagementJob_ModifyNotification                  56 int,int
#comfunc global IFsrmFileManagementJob_CreateNotificationAction            57 int,int,sptr
#comfunc global IFsrmFileManagementJob_EnumNotificationActions             58 int,sptr
#comfunc global IFsrmFileManagementJob_CreatePropertyCondition             59 wstr,sptr
#comfunc global IFsrmFileManagementJob_CreateCustomAction                  60 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。