Win32 API 日本語リファレンス
ホームSecurity.Authorization › IAzTask

IAzTask

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

公式ドキュメント

一連の操作を記述します。

メソッド 26

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

vtbl 7 HRESULT get_Name(LPWSTR* pbstrName)

タスクの名前を設定または取得します。(Get)

pbstrNameLPWSTR*outタスクの名前を受け取る文字列へのポインタである。

解説(Remarks)

Name プロパティの最大長は 64 文字です。

vtbl 8 HRESULT put_Name(LPWSTR bstrName)

タスクの名前を設定または取得します。(Put)

bstrNameLPWSTRinタスクに設定する名前を指定する。

解説(Remarks)

Name プロパティの最大長は 64 文字です。

vtbl 9 HRESULT get_Description(LPWSTR* pbstrDescription)

タスクを説明するコメントを設定または取得します。(Get)

pbstrDescriptionLPWSTR*outタスクの説明文を受け取る文字列へのポインタである。

解説(Remarks)

Description プロパティの最大長は 1,024 文字です。

vtbl 10 HRESULT put_Description(LPWSTR bstrDescription)

タスクを説明するコメントを設定または取得します。(Put)

bstrDescriptionLPWSTRinタスクに設定する説明文を指定する。

解説(Remarks)

Description プロパティの最大長は 1,024 文字です。

vtbl 11 HRESULT get_ApplicationData(LPWSTR* pbstrApplicationData)

IAzTask の ApplicationData プロパティは、アプリケーションが情報を格納するために使用できる不透明なフィールドを設定または取得します。(Get)

pbstrApplicationDataLPWSTR*outアプリケーション固有のデータ文字列を受け取る文字列へのポインタである。

解説(Remarks)

重要 ポリシー管理者はこのプロパティを読み書きできます。ポリシー管理者に公開すべきでないデータを ApplicationData プロパティに格納しないでください。
vtbl 12 HRESULT put_ApplicationData(LPWSTR bstrApplicationData)

IAzTask の ApplicationData プロパティは、アプリケーションが情報を格納するために使用できる不透明なフィールドを設定または取得します。(Put)

bstrApplicationDataLPWSTRinアプリケーション固有のデータ文字列を指定する。

解説(Remarks)

重要 ポリシー管理者はこのプロパティを読み書きできます。ポリシー管理者に公開すべきでないデータを ApplicationData プロパティに格納しないでください。
vtbl 13 HRESULT get_BizRule(LPWSTR* pbstrProp)

ビジネスルール (BizRule) を実装するスクリプトのテキストを設定または取得します。(Get)

pbstrPropLPWSTR*outタスクに関連付けられたビジネスルールのスクリプト本文を受け取る文字列へのポインタである。

解説(Remarks)

このプロパティの最大長は 65,536 文字です。

重要 このプロパティを設定する前に、BizRuleLanguage プロパティを設定しておく必要があります。
委任された IAzScope オブジェクトの子オブジェクトである IAzTask オブジェクトには、BizRule を関連付けることはできません。
vtbl 14 HRESULT put_BizRule(LPWSTR bstrProp)

ビジネスルール (BizRule) を実装するスクリプトのテキストを設定または取得します。(Put)

bstrPropLPWSTRinタスクに関連付けるビジネスルールのスクリプト本文を指定する。

解説(Remarks)

このプロパティの最大長は 65,536 文字です。

重要 このプロパティを設定する前に、BizRuleLanguage プロパティを設定しておく必要があります。
委任された IAzScope オブジェクトの子オブジェクトである IAzTask オブジェクトには、BizRule を関連付けることはできません。
vtbl 15 HRESULT get_BizRuleLanguage(LPWSTR* pbstrProp)

ビジネスルール (BizRule) が実装されているスクリプト言語を設定または取得します。(Get)

pbstrPropLPWSTR*outビジネスルールの記述言語 (VBScript や JScript) を表す文字列を受け取る文字列へのポインタである。

解説(Remarks)

このプロパティは、BizRule プロパティを設定する前に設定しておく必要があります。

vtbl 16 HRESULT put_BizRuleLanguage(LPWSTR bstrProp)

ビジネスルール (BizRule) が実装されているスクリプト言語を設定または取得します。(Put)

bstrPropLPWSTRinビジネスルールの記述言語 (VBScript や JScript) を表す文字列を指定する。

解説(Remarks)

このプロパティは、BizRule プロパティを設定する前に設定しておく必要があります。

vtbl 17 HRESULT get_BizRuleImportedPath(LPWSTR* pbstrProp)

ビジネスルール (BizRule) のインポート元となるファイルのパスを設定または取得します。(Get)

pbstrPropLPWSTR*outビジネスルールのインポート元ファイルパスを受け取る文字列へのポインタである。

解説(Remarks)

パス情報は UI で使用するために保存されます。UI は、ファイルの内容とこのプロパティを同期する仕組みを提供する必要があります。

このプロパティの最大長は 512 文字です。

vtbl 18 HRESULT put_BizRuleImportedPath(LPWSTR bstrProp)

ビジネスルール (BizRule) のインポート元となるファイルのパスを設定または取得します。(Put)

bstrPropLPWSTRinビジネスルールのインポート元ファイルパスを指定する。

解説(Remarks)

パス情報は UI で使用するために保存されます。UI は、ファイルの内容とこのプロパティを同期する仕組みを提供する必要があります。

このプロパティの最大長は 512 文字です。

vtbl 19 HRESULT get_IsRoleDefinition(BOOL* pfProp)

タスクがロール定義かどうかを示す値を設定または取得します。(Get)

pfPropBOOL*outこのタスクがロール定義かどうかを示す BOOL 値を受け取るポインタである。

解説(Remarks)

このプロパティはユーザーインターフェイス上の抽象化を表すものであり、タスクの機能には影響しません。

vtbl 20 HRESULT put_IsRoleDefinition(BOOL fProp)

タスクがロール定義かどうかを示す値を設定または取得します。(Put)

fPropBOOLinこのタスクをロール定義として扱うかどうかを示す BOOL 値を指定する。

解説(Remarks)

このプロパティはユーザーインターフェイス上の抽象化を表すものであり、タスクの機能には影響しません。

vtbl 21 HRESULT get_Operations(VARIANT* pvarProp)

タスクに関連付けられた操作を取得します。

pvarPropVARIANT*outこのタスクに含まれる操作の名前の配列を格納した VARIANT を受け取るポインタである。

解説(Remarks)

JScript では、返された SAFEARRAY を JScript の Array オブジェクトに変換する必要があります。

vtbl 22 HRESULT get_Tasks(VARIANT* pvarProp)

タスクに関連付けられたタスクを取得します。

pvarPropVARIANT*outこのタスクに含まれる下位タスクの名前の配列を格納した VARIANT を受け取るポインタである。

解説(Remarks)

このプロパティは、IAzTask オブジェクトが別の IAzTask オブジェクト内に入れ子になっている状態を示します。

JScript では、返された SAFEARRAY を JScript の Array オブジェクトに変換する必要があります。

vtbl 23 HRESULT AddOperation(LPWSTR bstrOp, VARIANT varReserved)

指定した名前の IAzOperation オブジェクトをタスクに追加します。

bstrOpLPWSTRinタスクに追加する IAzOperation オブジェクトの名前。
varReservedVARIANTin将来の使用のために予約されています。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の HRESULT 値は、操作が失敗したことを示します。

解説(Remarks)

このメソッドによる変更を永続化するには、Submit メソッドを呼び出す必要があります。

vtbl 24 HRESULT DeleteOperation(LPWSTR bstrOp, VARIANT varReserved)

指定した名前の IAzOperation オブジェクトをタスクから削除します。

bstrOpLPWSTRinタスクから削除する IAzOperation オブジェクトの名前。
varReservedVARIANTin将来の使用のために予約されています。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の HRESULT 値は、操作が失敗したことを示します。

解説(Remarks)

キャッシュから削除された IAzOperation オブジェクトへの IAzOperation 参照が残っている場合、その IAzOperation オブジェクトはもう使用できません。C++ では、IUnknown::Release メソッドを呼び出して、削除された IAzOperation オブジェクトへの参照を解放する必要があります。C# および Visual Basic では、削除されたオブジェクトへの参照は自動的に解放されます。

vtbl 25 HRESULT AddTask(LPWSTR bstrTask, VARIANT varReserved)

指定した名前の IAzTask オブジェクトをタスクに追加します。

bstrTaskLPWSTRinタスクに追加する IAzTask オブジェクトの名前。
varReservedVARIANTin将来の使用のために予約されています。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の HRESULT 値は、操作が失敗したことを示します。

解説(Remarks)

このメソッドにより、IAzTask オブジェクトを別の IAzTask オブジェクト内に入れ子にすることができます。

このメソッドによる変更を永続化するには、Submit メソッドを呼び出す必要があります。

vtbl 26 HRESULT DeleteTask(LPWSTR bstrTask, VARIANT varReserved)

指定した名前の IAzTask オブジェクトをタスクから削除します。

bstrTaskLPWSTRinタスクから削除する IAzTask オブジェクトの名前。
varReservedVARIANTin将来の使用のために予約されています。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の HRESULT 値は、操作が失敗したことを示します。

解説(Remarks)

キャッシュから削除された IAzTask オブジェクトへの IAzTask 参照が残っている場合、その IAzTask オブジェクトはもう使用できません。C++ では、IUnknown::Release メソッドを呼び出して、削除された IAzTask オブジェクトへの参照を解放する必要があります。C# および Visual Basic では、削除されたオブジェクトへの参照は自動的に解放されます。

vtbl 27 HRESULT get_Writable(BOOL* pfProp)

タスクを初期化したユーザーコンテキストによってタスクを変更できるかどうかを示す値を取得します。

pfPropBOOL*outタスクが書き込み可能かどうかを示す BOOL 値を受け取るポインタである。
vtbl 28 HRESULT GetProperty(INT lPropId, VARIANT varReserved, VARIANT* pvarProp)

指定したプロパティ ID を持つ IAzTask オブジェクトのプロパティを返します。

lPropIdINTin

返す IAzTask オブジェクトのプロパティのプロパティ ID。指定可能な値を次の表に示します。

意味
AZ_PROP_APPLICATION_DATA
ApplicationData プロパティからもアクセスできます
AZ_PROP_CHILD_CREATE
現在のユーザーが子オブジェクトを作成する権限を持っているかどうかを判断します。現在のユーザーが権限を持っている場合、この値は TRUE になります。それ以外の場合は FALSE です。
AZ_PROP_DESCRIPTION
Description プロパティからもアクセスできます
AZ_PROP_NAME
Name プロパティからもアクセスできます
AZ_PROP_TASK_BIZRULE
BizRule プロパティからもアクセスできます
AZ_PROP_TASK_BIZRULE_LANGUAGE
BizRuleLanguage プロパティからもアクセスできます
AZ_PROP_TASK_IS_ROLE_DEFINITION
IsRoleDefinition プロパティからもアクセスできます
AZ_PROP_TASK_OPERATIONS
Operations プロパティからもアクセスできます
AZ_PROP_TASK_TASKS
Tasks プロパティからもアクセスできます
AZ_PROP_WRITABLE
Writable プロパティからもアクセスできます
varReservedVARIANTin将来の使用のために予約されています。
pvarPropVARIANT*out返される IAzTask オブジェクトのプロパティへのポインター。

戻り値

戻り値は HRESULT です。S_OK は成功を示します。それ以外の値は、操作が失敗したことを示します。

vtbl 29 HRESULT SetProperty(INT lPropId, VARIANT varProp, VARIANT varReserved)

指定したプロパティ ID を持つ IAzTask オブジェクトのプロパティに、指定した値を設定します。

lPropIdINTin

設定する IAzTask オブジェクトのプロパティのプロパティ ID。指定可能な値を次の表に示します。

意味
AZ_PROP_APPLICATION_DATA
ApplicationData プロパティからもアクセスできます
AZ_PROP_DESCRIPTION
Description プロパティからもアクセスできます
AZ_PROP_NAME
Name プロパティからもアクセスできます
AZ_PROP_TASK_BIZRULE
BizRule プロパティからもアクセスできます
AZ_PROP_TASK_BIZRULE_LANGUAGE
BizRuleLanguage プロパティからもアクセスできます
AZ_PROP_TASK_IS_ROLE_DEFINITION
IsRoleDefinition プロパティからもアクセスできます
varPropVARIANTin

lPropId パラメーターで指定した IAzTask オブジェクトのプロパティに設定する値。lPropId パラメーターの値に応じて使用しなければならないデータ型を次の表に示します。

lPropId の値 データ型
AZ_PROP_APPLICATION_DATA
BSTR
AZ_PROP_DESCRIPTION
BSTR
AZ_PROP_NAME
BSTR
AZ_PROP_TASK_BIZRULE
BSTR
AZ_PROP_TASK_BIZRULE_LANGUAGE
BSTR
AZ_PROP_IS_ROLE_DEFINITION
BOOL
varReservedVARIANTin将来の使用のために予約されています。

戻り値

戻り値は HRESULT です。S_OK は成功を示します。それ以外の値は、操作が失敗したことを示します。

解説(Remarks)

このメソッドによる変更を永続化するには、Submit メソッドを呼び出す必要があります。

vtbl 30 HRESULT AddPropertyItem(INT lPropId, VARIANT varProp, VARIANT varReserved)

指定したエンティティを指定したリストに追加します。(IAzTask.AddPropertyItem)

lPropIdINTin

varProp パラメーターで指定したエンティティを追加するリストのプロパティ ID。指定可能な値を次の表に示します。

意味
AZ_PROP_TASK_OPERATIONS
AddOperation メソッドを使用して追加することもできます
AZ_PROP_TASK_TASKS
AddTask メソッドを使用して追加することもできます
varPropVARIANTin

lPropId パラメーターで指定したリストに追加するエンティティの名前。

バリアントは BSTR バリアントである必要があります。

varReservedVARIANTin将来の使用のために予約されています。

戻り値

戻り値は HRESULT です。S_OK は成功を示します。それ以外の値は、操作が失敗したことを示します。

解説(Remarks)

このメソッドによる変更を永続化するには、Submit メソッドを呼び出す必要があります。

vtbl 31 HRESULT DeletePropertyItem(INT lPropId, VARIANT varProp, VARIANT varReserved)

指定したエンティティを指定したリストから削除します。(IAzTask.DeletePropertyItem)

lPropIdINTin

varProp パラメーターで指定したエンティティを削除するリストのプロパティ ID。指定可能な値を次の表に示します。

意味
AZ_PROP_TASK_OPERATIONS
DeleteOperation メソッドを使用して削除することもできます
AZ_PROP_TASK_TASKS
DeleteTask メソッドを使用して削除することもできます
varPropVARIANTin

lPropId パラメーターで指定したリストから削除するエンティティの名前。

バリアントは BSTR バリアントである必要があります。

varReservedVARIANTin将来の使用のために予約されています。

戻り値

戻り値は HRESULT です。S_OK は成功を示します。それ以外の値は、操作が失敗したことを示します。

vtbl 32 HRESULT Submit(INT lFlags, VARIANT varReserved)

IAzTask オブジェクトに加えられた変更を永続化します。

lFlagsINTinSubmit メソッドの動作を変更するフラグ。既定値は 0 です。AZ_SUBMIT_FLAG_ABORT フラグを指定した場合、オブジェクトへの変更は破棄され、オブジェクトは基になるポリシーストアと一致するように更新されます。
varReservedVARIANTin将来の使用のために予約されています。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の HRESULT 値は、操作が失敗したことを示します。

解説(Remarks)

IAzTask オブジェクトへの追加や変更は、Submit メソッドが呼び出されるまで永続化されません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_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 不要)。