IAzTask
COMIDispatch (デュアル)comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。公式ドキュメント
一連の操作を記述します。
メソッド 26
vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。
タスクの名前を設定または取得します。(Get)
| pbstrName | LPWSTR* | out | タスクの名前を受け取る文字列へのポインタである。 |
解説(Remarks)
Name プロパティの最大長は 64 文字です。
タスクの名前を設定または取得します。(Put)
| bstrName | LPWSTR | in | タスクに設定する名前を指定する。 |
解説(Remarks)
Name プロパティの最大長は 64 文字です。
タスクを説明するコメントを設定または取得します。(Get)
| pbstrDescription | LPWSTR* | out | タスクの説明文を受け取る文字列へのポインタである。 |
解説(Remarks)
Description プロパティの最大長は 1,024 文字です。
タスクを説明するコメントを設定または取得します。(Put)
| bstrDescription | LPWSTR | in | タスクに設定する説明文を指定する。 |
解説(Remarks)
Description プロパティの最大長は 1,024 文字です。
IAzTask の ApplicationData プロパティは、アプリケーションが情報を格納するために使用できる不透明なフィールドを設定または取得します。(Get)
| pbstrApplicationData | LPWSTR* | out | アプリケーション固有のデータ文字列を受け取る文字列へのポインタである。 |
解説(Remarks)
IAzTask の ApplicationData プロパティは、アプリケーションが情報を格納するために使用できる不透明なフィールドを設定または取得します。(Put)
| bstrApplicationData | LPWSTR | in | アプリケーション固有のデータ文字列を指定する。 |
解説(Remarks)
ビジネスルール (BizRule) を実装するスクリプトのテキストを設定または取得します。(Get)
| pbstrProp | LPWSTR* | out | タスクに関連付けられたビジネスルールのスクリプト本文を受け取る文字列へのポインタである。 |
解説(Remarks)
このプロパティの最大長は 65,536 文字です。
ビジネスルール (BizRule) を実装するスクリプトのテキストを設定または取得します。(Put)
| bstrProp | LPWSTR | in | タスクに関連付けるビジネスルールのスクリプト本文を指定する。 |
解説(Remarks)
このプロパティの最大長は 65,536 文字です。
ビジネスルール (BizRule) が実装されているスクリプト言語を設定または取得します。(Get)
| pbstrProp | LPWSTR* | out | ビジネスルールの記述言語 (VBScript や JScript) を表す文字列を受け取る文字列へのポインタである。 |
解説(Remarks)
このプロパティは、BizRule プロパティを設定する前に設定しておく必要があります。
ビジネスルール (BizRule) が実装されているスクリプト言語を設定または取得します。(Put)
| bstrProp | LPWSTR | in | ビジネスルールの記述言語 (VBScript や JScript) を表す文字列を指定する。 |
解説(Remarks)
このプロパティは、BizRule プロパティを設定する前に設定しておく必要があります。
ビジネスルール (BizRule) のインポート元となるファイルのパスを設定または取得します。(Get)
| pbstrProp | LPWSTR* | out | ビジネスルールのインポート元ファイルパスを受け取る文字列へのポインタである。 |
解説(Remarks)
パス情報は UI で使用するために保存されます。UI は、ファイルの内容とこのプロパティを同期する仕組みを提供する必要があります。
このプロパティの最大長は 512 文字です。
ビジネスルール (BizRule) のインポート元となるファイルのパスを設定または取得します。(Put)
| bstrProp | LPWSTR | in | ビジネスルールのインポート元ファイルパスを指定する。 |
解説(Remarks)
パス情報は UI で使用するために保存されます。UI は、ファイルの内容とこのプロパティを同期する仕組みを提供する必要があります。
このプロパティの最大長は 512 文字です。
タスクがロール定義かどうかを示す値を設定または取得します。(Get)
| pfProp | BOOL* | out | このタスクがロール定義かどうかを示す BOOL 値を受け取るポインタである。 |
解説(Remarks)
このプロパティはユーザーインターフェイス上の抽象化を表すものであり、タスクの機能には影響しません。
タスクがロール定義かどうかを示す値を設定または取得します。(Put)
| fProp | BOOL | in | このタスクをロール定義として扱うかどうかを示す BOOL 値を指定する。 |
解説(Remarks)
このプロパティはユーザーインターフェイス上の抽象化を表すものであり、タスクの機能には影響しません。
タスクに関連付けられた操作を取得します。
| pvarProp | VARIANT* | out | このタスクに含まれる操作の名前の配列を格納した VARIANT を受け取るポインタである。 |
解説(Remarks)
タスクに関連付けられたタスクを取得します。
| pvarProp | VARIANT* | out | このタスクに含まれる下位タスクの名前の配列を格納した VARIANT を受け取るポインタである。 |
解説(Remarks)
このプロパティは、IAzTask オブジェクトが別の IAzTask オブジェクト内に入れ子になっている状態を示します。
JScript では、返された SAFEARRAY を JScript の Array オブジェクトに変換する必要があります。
指定した名前の IAzOperation オブジェクトをタスクに追加します。
| bstrOp | LPWSTR | in | タスクに追加する IAzOperation オブジェクトの名前。 |
| varReserved | VARIANT | in | 将来の使用のために予約されています。 |
戻り値
メソッドが成功した場合は S_OK を返します。それ以外の HRESULT 値は、操作が失敗したことを示します。
解説(Remarks)
このメソッドによる変更を永続化するには、Submit メソッドを呼び出す必要があります。
指定した名前の IAzOperation オブジェクトをタスクから削除します。
| bstrOp | LPWSTR | in | タスクから削除する IAzOperation オブジェクトの名前。 |
| varReserved | VARIANT | in | 将来の使用のために予約されています。 |
戻り値
メソッドが成功した場合は S_OK を返します。それ以外の HRESULT 値は、操作が失敗したことを示します。
解説(Remarks)
キャッシュから削除された IAzOperation オブジェクトへの IAzOperation 参照が残っている場合、その IAzOperation オブジェクトはもう使用できません。C++ では、IUnknown::Release メソッドを呼び出して、削除された IAzOperation オブジェクトへの参照を解放する必要があります。C# および Visual Basic では、削除されたオブジェクトへの参照は自動的に解放されます。
指定した名前の IAzTask オブジェクトをタスクに追加します。
| bstrTask | LPWSTR | in | タスクに追加する IAzTask オブジェクトの名前。 |
| varReserved | VARIANT | in | 将来の使用のために予約されています。 |
戻り値
メソッドが成功した場合は S_OK を返します。それ以外の HRESULT 値は、操作が失敗したことを示します。
解説(Remarks)
このメソッドにより、IAzTask オブジェクトを別の IAzTask オブジェクト内に入れ子にすることができます。
このメソッドによる変更を永続化するには、Submit メソッドを呼び出す必要があります。
指定した名前の IAzTask オブジェクトをタスクから削除します。
| bstrTask | LPWSTR | in | タスクから削除する IAzTask オブジェクトの名前。 |
| varReserved | VARIANT | in | 将来の使用のために予約されています。 |
戻り値
メソッドが成功した場合は S_OK を返します。それ以外の HRESULT 値は、操作が失敗したことを示します。
解説(Remarks)
キャッシュから削除された IAzTask オブジェクトへの IAzTask 参照が残っている場合、その IAzTask オブジェクトはもう使用できません。C++ では、IUnknown::Release メソッドを呼び出して、削除された IAzTask オブジェクトへの参照を解放する必要があります。C# および Visual Basic では、削除されたオブジェクトへの参照は自動的に解放されます。
タスクを初期化したユーザーコンテキストによってタスクを変更できるかどうかを示す値を取得します。
| pfProp | BOOL* | out | タスクが書き込み可能かどうかを示す BOOL 値を受け取るポインタである。 |
指定したプロパティ ID を持つ IAzTask オブジェクトのプロパティを返します。
| lPropId | INT | in | 返す IAzTask オブジェクトのプロパティのプロパティ ID。指定可能な値を次の表に示します。
| ||||||||||||||||||||||
| varReserved | VARIANT | in | 将来の使用のために予約されています。 | ||||||||||||||||||||||
| pvarProp | VARIANT* | out | 返される IAzTask オブジェクトのプロパティへのポインター。 |
戻り値
戻り値は HRESULT です。S_OK は成功を示します。それ以外の値は、操作が失敗したことを示します。
指定したプロパティ ID を持つ IAzTask オブジェクトのプロパティに、指定した値を設定します。
| lPropId | INT | in | 設定する IAzTask オブジェクトのプロパティのプロパティ ID。指定可能な値を次の表に示します。
| ||||||||||||||
| varProp | VARIANT | in | lPropId パラメーターで指定した IAzTask オブジェクトのプロパティに設定する値。lPropId パラメーターの値に応じて使用しなければならないデータ型を次の表に示します。
| ||||||||||||||
| varReserved | VARIANT | in | 将来の使用のために予約されています。 |
戻り値
戻り値は HRESULT です。S_OK は成功を示します。それ以外の値は、操作が失敗したことを示します。
解説(Remarks)
このメソッドによる変更を永続化するには、Submit メソッドを呼び出す必要があります。
指定したエンティティを指定したリストに追加します。(IAzTask.AddPropertyItem)
| lPropId | INT | in | varProp パラメーターで指定したエンティティを追加するリストのプロパティ ID。指定可能な値を次の表に示します。
| ||||||
| varProp | VARIANT | in | lPropId パラメーターで指定したリストに追加するエンティティの名前。 バリアントは BSTR バリアントである必要があります。 | ||||||
| varReserved | VARIANT | in | 将来の使用のために予約されています。 |
戻り値
戻り値は HRESULT です。S_OK は成功を示します。それ以外の値は、操作が失敗したことを示します。
解説(Remarks)
このメソッドによる変更を永続化するには、Submit メソッドを呼び出す必要があります。
指定したエンティティを指定したリストから削除します。(IAzTask.DeletePropertyItem)
| lPropId | INT | in | varProp パラメーターで指定したエンティティを削除するリストのプロパティ ID。指定可能な値を次の表に示します。
| ||||||
| varProp | VARIANT | in | lPropId パラメーターで指定したリストから削除するエンティティの名前。 バリアントは BSTR バリアントである必要があります。 | ||||||
| varReserved | VARIANT | in | 将来の使用のために予約されています。 |
戻り値
戻り値は HRESULT です。S_OK は成功を示します。それ以外の値は、操作が失敗したことを示します。
IAzTask オブジェクトに加えられた変更を永続化します。
| lFlags | INT | in | Submit メソッドの動作を変更するフラグ。既定値は 0 です。AZ_SUBMIT_FLAG_ABORT フラグを指定した場合、オブジェクトへの変更は破棄され、オブジェクトは基になるポリシーストアと一致するように更新されます。 |
| varReserved | VARIANT | in | 将来の使用のために予約されています。 |
戻り値
メソッドが成功した場合は S_OK を返します。それ以外の HRESULT 値は、操作が失敗したことを示します。
解説(Remarks)
IAzTask オブジェクトへの追加や変更は、Submit メソッドが呼び出されるまで永続化されません。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IAzTask "{CB94E592-2E0E-4A6C-A336-B89A6DC1E388}" #usecom global IAzTask IID_IAzTask "{}" #comfunc global IAzTask_get_Name 7 var #comfunc global IAzTask_put_Name 8 wstr #comfunc global IAzTask_get_Description 9 var #comfunc global IAzTask_put_Description 10 wstr #comfunc global IAzTask_get_ApplicationData 11 var #comfunc global IAzTask_put_ApplicationData 12 wstr #comfunc global IAzTask_get_BizRule 13 var #comfunc global IAzTask_put_BizRule 14 wstr #comfunc global IAzTask_get_BizRuleLanguage 15 var #comfunc global IAzTask_put_BizRuleLanguage 16 wstr #comfunc global IAzTask_get_BizRuleImportedPath 17 var #comfunc global IAzTask_put_BizRuleImportedPath 18 wstr #comfunc global IAzTask_get_IsRoleDefinition 19 var #comfunc global IAzTask_put_IsRoleDefinition 20 int #comfunc global IAzTask_get_Operations 21 var #comfunc global IAzTask_get_Tasks 22 var #comfunc global IAzTask_AddOperation 23 wstr,int #comfunc global IAzTask_DeleteOperation 24 wstr,int #comfunc global IAzTask_AddTask 25 wstr,int #comfunc global IAzTask_DeleteTask 26 wstr,int #comfunc global IAzTask_get_Writable 27 var #comfunc global IAzTask_GetProperty 28 int,int,var #comfunc global IAzTask_SetProperty 29 int,int,int #comfunc global IAzTask_AddPropertyItem 30 int,int,int #comfunc global IAzTask_DeletePropertyItem 31 int,int,int #comfunc global IAzTask_Submit 32 int,int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IAzTask "{CB94E592-2E0E-4A6C-A336-B89A6DC1E388}" #usecom global IAzTask IID_IAzTask "{}" #comfunc global IAzTask_get_Name 7 sptr #comfunc global IAzTask_put_Name 8 wstr #comfunc global IAzTask_get_Description 9 sptr #comfunc global IAzTask_put_Description 10 wstr #comfunc global IAzTask_get_ApplicationData 11 sptr #comfunc global IAzTask_put_ApplicationData 12 wstr #comfunc global IAzTask_get_BizRule 13 sptr #comfunc global IAzTask_put_BizRule 14 wstr #comfunc global IAzTask_get_BizRuleLanguage 15 sptr #comfunc global IAzTask_put_BizRuleLanguage 16 wstr #comfunc global IAzTask_get_BizRuleImportedPath 17 sptr #comfunc global IAzTask_put_BizRuleImportedPath 18 wstr #comfunc global IAzTask_get_IsRoleDefinition 19 sptr #comfunc global IAzTask_put_IsRoleDefinition 20 int #comfunc global IAzTask_get_Operations 21 sptr #comfunc global IAzTask_get_Tasks 22 sptr #comfunc global IAzTask_AddOperation 23 wstr,int #comfunc global IAzTask_DeleteOperation 24 wstr,int #comfunc global IAzTask_AddTask 25 wstr,int #comfunc global IAzTask_DeleteTask 26 wstr,int #comfunc global IAzTask_get_Writable 27 sptr #comfunc global IAzTask_GetProperty 28 int,int,sptr #comfunc global IAzTask_SetProperty 29 int,int,int #comfunc global IAzTask_AddPropertyItem 30 int,int,int #comfunc global IAzTask_DeletePropertyItem 31 int,int,int #comfunc global IAzTask_Submit 32 int,int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。