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

IFsrmClassificationManager

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDd2dc89da-ee91-48a0-85d8-cc72a56f7d04継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

メソッド 27

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

vtbl 7 HRESULT get_ClassificationReportFormats(SAFEARRAY** formats)
formatsSAFEARRAY**out分類レポートの出力形式の一覧を格納した SAFEARRAY を受け取るポインタである。
vtbl 8 HRESULT put_ClassificationReportFormats(SAFEARRAY* formats)
formatsSAFEARRAY*in分類レポートの出力形式として設定する一覧を格納した SAFEARRAY を指定する。
vtbl 9 HRESULT get_Logging(INT* logging)
loggingINT*out分類処理のログ記録動作を制御するフラグの組み合わせを受け取るポインタである。
vtbl 10 HRESULT put_Logging(INT logging)
loggingINTin分類処理のログ記録動作を制御するフラグの組み合わせを指定する。
vtbl 11 HRESULT get_ClassificationReportMailTo(LPWSTR* mailTo)
mailToLPWSTR*out分類レポートの送信先メールアドレスを受け取る文字列ポインタである。
vtbl 12 HRESULT put_ClassificationReportMailTo(LPWSTR mailTo)
mailToLPWSTRin分類レポートの送信先として設定するメールアドレスを指定する文字列である。
vtbl 13 HRESULT get_ClassificationReportEnabled(VARIANT_BOOL* reportEnabled)
reportEnabledVARIANT_BOOL*out分類レポートの生成が有効かどうかを示す VARIANT_BOOL を受け取るポインタである。
vtbl 14 HRESULT put_ClassificationReportEnabled(VARIANT_BOOL reportEnabled)
reportEnabledVARIANT_BOOLin分類レポートの生成を有効にするかどうかを指定する VARIANT_BOOL である。
vtbl 15 HRESULT get_ClassificationLastReportPathWithoutExtension(LPWSTR* lastReportPath)
lastReportPathLPWSTR*out最後に生成された分類レポートの拡張子を除いたパスを受け取る文字列ポインタである。
vtbl 16 HRESULT get_ClassificationLastError(LPWSTR* lastError)
lastErrorLPWSTR*out最後の分類処理で発生したエラーメッセージを受け取る文字列ポインタである。
vtbl 17 HRESULT get_ClassificationRunningStatus(FsrmReportRunningStatus* runningStatus)
runningStatusFsrmReportRunningStatus*out分類処理の現在の実行状態を示す FsrmReportRunningStatus 列挙値を受け取るポインタである。
vtbl 18 HRESULT EnumPropertyDefinitions(FsrmEnumOptions options, IFsrmCollection** propertyDefinitions)
optionsFsrmEnumOptionsin列挙時の動作を制御する FsrmEnumOptions 列挙値を指定する。
propertyDefinitionsIFsrmCollection**out列挙されたプロパティ定義を格納するコレクション IFsrmCollection を受け取るポインタである。
vtbl 19 HRESULT CreatePropertyDefinition(IFsrmPropertyDefinition** propertyDefinition)
propertyDefinitionIFsrmPropertyDefinition**out新規に作成されたプロパティ定義の IFsrmPropertyDefinition インターフェイスを受け取るポインタである。
vtbl 20 HRESULT GetPropertyDefinition(LPWSTR propertyName, IFsrmPropertyDefinition** propertyDefinition)
propertyNameLPWSTRin取得対象のプロパティ定義の名前を指定する文字列である。
propertyDefinitionIFsrmPropertyDefinition**out指定した名前に一致するプロパティ定義の IFsrmPropertyDefinition インターフェイスを受け取るポインタである。
vtbl 21 HRESULT EnumRules(FsrmRuleType ruleType, FsrmEnumOptions options, IFsrmCollection** Rules)
ruleTypeFsrmRuleTypein列挙対象とするルールの種類を示す FsrmRuleType 列挙値を指定する。
optionsFsrmEnumOptionsin列挙時の動作を制御する FsrmEnumOptions 列挙値を指定する。
RulesIFsrmCollection**out列挙されたルールを格納するコレクション IFsrmCollection を受け取るポインタである。
vtbl 22 HRESULT CreateRule(FsrmRuleType ruleType, IFsrmRule** Rule)
ruleTypeFsrmRuleTypein作成するルールの種類を示す FsrmRuleType 列挙値を指定する。
RuleIFsrmRule**out新規に作成されたルールの IFsrmRule インターフェイスを受け取るポインタである。
vtbl 23 HRESULT GetRule(LPWSTR ruleName, FsrmRuleType ruleType, IFsrmRule** Rule)
ruleNameLPWSTRin取得対象のルールの名前を指定する文字列である。
ruleTypeFsrmRuleTypein取得対象のルールの種類を示す FsrmRuleType 列挙値を指定する。
RuleIFsrmRule**out指定した名前と種類に一致するルールの IFsrmRule インターフェイスを受け取るポインタである。
vtbl 24 HRESULT EnumModuleDefinitions(FsrmPipelineModuleType moduleType, FsrmEnumOptions options, IFsrmCollection** moduleDefinitions)
moduleTypeFsrmPipelineModuleTypein列挙対象とするモジュールの種類を示す FsrmPipelineModuleType 列挙値を指定する。
optionsFsrmEnumOptionsin列挙時の動作を制御する FsrmEnumOptions 列挙値を指定する。
moduleDefinitionsIFsrmCollection**out列挙されたモジュール定義を格納するコレクション IFsrmCollection を受け取るポインタである。
vtbl 25 HRESULT CreateModuleDefinition(FsrmPipelineModuleType moduleType, IFsrmPipelineModuleDefinition** moduleDefinition)
moduleTypeFsrmPipelineModuleTypein作成するモジュールの種類を示す FsrmPipelineModuleType 列挙値を指定する。
moduleDefinitionIFsrmPipelineModuleDefinition**out新規に作成されたモジュール定義の IFsrmPipelineModuleDefinition インターフェイスを受け取るポインタである。
vtbl 26 HRESULT GetModuleDefinition(LPWSTR moduleName, FsrmPipelineModuleType moduleType, IFsrmPipelineModuleDefinition** moduleDefinition)
moduleNameLPWSTRin取得対象のモジュール定義の名前を指定する文字列である。
moduleTypeFsrmPipelineModuleTypein取得対象のモジュールの種類を示す FsrmPipelineModuleType 列挙値を指定する。
moduleDefinitionIFsrmPipelineModuleDefinition**out指定した名前と種類に一致するモジュール定義の IFsrmPipelineModuleDefinition インターフェイスを受け取るポインタである。
vtbl 27 HRESULT RunClassification(FsrmReportGenerationContext context, LPWSTR reserved)
contextFsrmReportGenerationContextin分類処理を実行する際の生成コンテキストを示す FsrmReportGenerationContext 列挙値を指定する。
reservedLPWSTRin将来の使用のために予約された引数である。NULL を指定する。
vtbl 28 HRESULT WaitForClassificationCompletion(INT waitSeconds, VARIANT_BOOL* completed)
waitSecondsINTin完了を待機する最大秒数を指定する。0 は待機なし、負の値は無制限の待機を意味する。
completedVARIANT_BOOL*out待機時間内に分類処理が完了したかどうかを示す VARIANT_BOOL を受け取るポインタである。
vtbl 29 HRESULT CancelClassification()
vtbl 30 HRESULT EnumFileProperties(LPWSTR filePath, FsrmGetFilePropertyOptions options, IFsrmCollection** fileProperties)
filePathLPWSTRinプロパティを列挙する対象ファイルのパスを指定する文字列である。
optionsFsrmGetFilePropertyOptionsinファイルプロパティの取得方法を制御する FsrmGetFilePropertyOptions 列挙値を指定する。
filePropertiesIFsrmCollection**out列挙されたファイルプロパティを格納するコレクション IFsrmCollection を受け取るポインタである。
vtbl 31 HRESULT GetFileProperty(LPWSTR filePath, LPWSTR propertyName, FsrmGetFilePropertyOptions options, IFsrmProperty** property)
filePathLPWSTRinプロパティを取得する対象ファイルのパスを指定する文字列である。
propertyNameLPWSTRin取得対象のプロパティの名前を指定する文字列である。
optionsFsrmGetFilePropertyOptionsinファイルプロパティの取得方法を制御する FsrmGetFilePropertyOptions 列挙値を指定する。
propertyIFsrmProperty**out指定したファイルのプロパティを表す IFsrmProperty インターフェイスを受け取るポインタである。
vtbl 32 HRESULT SetFileProperty(LPWSTR filePath, LPWSTR propertyName, LPWSTR propertyValue)
filePathLPWSTRinプロパティを設定する対象ファイルのパスを指定する文字列である。
propertyNameLPWSTRin設定対象のプロパティの名前を指定する文字列である。
propertyValueLPWSTRinプロパティに設定する値を指定する文字列である。
vtbl 33 HRESULT ClearFileProperty(LPWSTR filePath, LPWSTR property)
filePathLPWSTRinプロパティをクリアする対象ファイルのパスを指定する文字列である。
propertyLPWSTRinクリア対象のプロパティの名前を指定する文字列である。

HSP用 COM定義

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

出力引数:
#define global IID_IFsrmClassificationManager "{D2DC89DA-EE91-48A0-85D8-CC72A56F7D04}"
#usecom global IFsrmClassificationManager IID_IFsrmClassificationManager "{B15C0E47-C391-45B9-95C8-EB596C853F3A}"
#comfunc global IFsrmClassificationManager_get_ClassificationReportFormats                   7 var
#comfunc global IFsrmClassificationManager_put_ClassificationReportFormats                   8 var
#comfunc global IFsrmClassificationManager_get_Logging                                       9 var
#comfunc global IFsrmClassificationManager_put_Logging                                       10 int
#comfunc global IFsrmClassificationManager_get_ClassificationReportMailTo                    11 var
#comfunc global IFsrmClassificationManager_put_ClassificationReportMailTo                    12 wstr
#comfunc global IFsrmClassificationManager_get_ClassificationReportEnabled                   13 var
#comfunc global IFsrmClassificationManager_put_ClassificationReportEnabled                   14 int
#comfunc global IFsrmClassificationManager_get_ClassificationLastReportPathWithoutExtension  15 var
#comfunc global IFsrmClassificationManager_get_ClassificationLastError                       16 var
#comfunc global IFsrmClassificationManager_get_ClassificationRunningStatus                   17 var
#comfunc global IFsrmClassificationManager_EnumPropertyDefinitions                           18 int,sptr
#comfunc global IFsrmClassificationManager_CreatePropertyDefinition                          19 sptr
#comfunc global IFsrmClassificationManager_GetPropertyDefinition                             20 wstr,sptr
#comfunc global IFsrmClassificationManager_EnumRules                                         21 int,int,sptr
#comfunc global IFsrmClassificationManager_CreateRule                                        22 int,sptr
#comfunc global IFsrmClassificationManager_GetRule                                           23 wstr,int,sptr
#comfunc global IFsrmClassificationManager_EnumModuleDefinitions                             24 int,int,sptr
#comfunc global IFsrmClassificationManager_CreateModuleDefinition                            25 int,sptr
#comfunc global IFsrmClassificationManager_GetModuleDefinition                               26 wstr,int,sptr
#comfunc global IFsrmClassificationManager_RunClassification                                 27 int,wstr
#comfunc global IFsrmClassificationManager_WaitForClassificationCompletion                   28 int,var
#comfunc global IFsrmClassificationManager_CancelClassification                              29
#comfunc global IFsrmClassificationManager_EnumFileProperties                                30 wstr,int,sptr
#comfunc global IFsrmClassificationManager_GetFileProperty                                   31 wstr,wstr,int,sptr
#comfunc global IFsrmClassificationManager_SetFileProperty                                   32 wstr,wstr,wstr
#comfunc global IFsrmClassificationManager_ClearFileProperty                                 33 wstr,wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。