Win32 API 日本語リファレンス
ホームSystem.TaskScheduler › IPrincipal

IPrincipal

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

公式ドキュメント

プリンシパルのセキュリティ資格情報を提供します。

解説(Remarks)

アカウントを指定する際は、ドメイン名とユーザー名を指定するために、コード内で二重のバックスラッシュを正しく使用することを忘れないでください。たとえば、UserId プロパティの値を指定するには DOMAIN\UserName を使用します。

タスクの XML を読み書きする際、プリンシパルのセキュリティ資格情報は Task Scheduler スキーマの Principal 要素で指定します。

at.exe コマンドラインツールを使用してタスクが登録され、このインターフェースを使用してそのタスクの情報を取得する場合、LogonType プロパティは 0 を返し、RunLevel プロパティは 0 を返し、UserId プロパティは NULL を返します。

このインターフェースの詳細とサンプルコードについては、Time Trigger Example (C++) または Registration Trigger Example (C++) を参照してください。

メソッド 12

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

vtbl 7 HRESULT get_Id(LPWSTR* pId)

プリンシパルの識別子を取得または設定します。(Get)

pIdLPWSTR*inoutプリンシパルの識別子文字列を受け取る出力ポインタである。SysFreeString で解放する。

解説(Remarks)

この識別子は、IActionCollection::Context プロパティを指定する際にも使用されます。

タスクの XML を読み書きする際、プリンシパルの識別子は Task Scheduler スキーマの Principal 要素の Id 属性で指定します。

vtbl 8 HRESULT put_Id(LPWSTR Id)

プリンシパルの識別子を取得または設定します。(Put)

IdLPWSTRinプリンシパルに設定する識別子文字列を指定する。

解説(Remarks)

この識別子は、IActionCollection::Context プロパティを指定する際にも使用されます。

タスクの XML を読み書きする際、プリンシパルの識別子は Task Scheduler スキーマの Principal 要素の Id 属性で指定します。

vtbl 9 HRESULT get_DisplayName(LPWSTR* pName)

プリンシパルの名前を取得または設定します。(Get)

pNameLPWSTR*inoutプリンシパルの表示名を受け取る出力ポインタである。SysFreeString で解放する。

解説(Remarks)

タスクの XML を読み書きする際、プリンシパルの表示名は Task Scheduler スキーマの DisplayName 要素で指定します。

このプロパティ値を設定する際、値はリソース .dll ファイルから取得したテキストにすることができます。リソースファイル内のテキストを参照するには、専用の文字列を使用します。文字列の形式は $(@ [Dll], [ResourceID]) で、[Dll] はリソースを含む .dll ファイルへのパス、[ResourceID] はリソーステキストの識別子です。たとえば、このプロパティ値を $(@ %SystemRoot%\System32\ResourceName.dll, -101) に設定すると、%SystemRoot%\System32\ResourceName.dll ファイル内で識別子が -101 に等しいリソーステキストの値がプロパティに設定されます。

vtbl 10 HRESULT put_DisplayName(LPWSTR name)

プリンシパルの名前を取得または設定します。(Put)

nameLPWSTRinプリンシパルに設定する表示名を指定する。

解説(Remarks)

タスクの XML を読み書きする際、プリンシパルの表示名は Task Scheduler スキーマの DisplayName 要素で指定します。

このプロパティ値を設定する際、値はリソース .dll ファイルから取得したテキストにすることができます。リソースファイル内のテキストを参照するには、専用の文字列を使用します。文字列の形式は $(@ [Dll], [ResourceID]) で、[Dll] はリソースを含む .dll ファイルへのパス、[ResourceID] はリソーステキストの識別子です。たとえば、このプロパティ値を $(@ %SystemRoot%\System32\ResourceName.dll, -101) に設定すると、%SystemRoot%\System32\ResourceName.dll ファイル内で識別子が -101 に等しいリソーステキストの値がプロパティに設定されます。

vtbl 11 HRESULT get_UserId(LPWSTR* pUser)

プリンシパルに関連付けられたタスクの実行に必要なユーザー識別子を取得または設定します。(Get)

pUserLPWSTR*inoutタスクを実行するユーザーの ID を受け取る出力ポインタである。SysFreeString で解放する。

解説(Remarks)

GroupId プロパティにグループ識別子が指定されている場合は、このプロパティを設定しないでください。

タスクの XML を読み書きする際、プリンシパルのユーザー識別子は Task Scheduler スキーマの UserId 要素で指定します。

vtbl 12 HRESULT put_UserId(LPWSTR user)

プリンシパルに関連付けられたタスクの実行に必要なユーザー識別子を取得または設定します。(Put)

userLPWSTRinタスクを実行するユーザーの ID を指定する。

解説(Remarks)

GroupId プロパティにグループ識別子が指定されている場合は、このプロパティを設定しないでください。

タスクの XML を読み書きする際、プリンシパルのユーザー識別子は Task Scheduler スキーマの UserId 要素で指定します。

vtbl 13 HRESULT get_LogonType(TASK_LOGON_TYPE* pLogon)

プリンシパルに関連付けられたタスクの実行に必要なセキュリティログオン方法を取得または設定します。(Get)

pLogonTASK_LOGON_TYPE*inoutタスク実行時に使用されるログオン方法を表す TASK_LOGON_TYPE 値を受け取る変数へのポインタである。

解説(Remarks)

このプロパティは、UserId プロパティによってユーザー識別子が指定されている場合にのみ有効です。

タスクの XML を読み書きする際、ログオンの種類は Task Scheduler スキーマの <LogonType> 要素で指定します。

メッセージボックスアクションを含むタスクの場合、タスクがアクティブ化され、そのタスクが対話型のログオンの種類を持っているときにメッセージボックスが表示されます。タスクのログオンの種類を対話型に設定するには、タスクプリンシパルの LogonType プロパティ、または ITaskFolder::RegisterTaskITaskFolder::RegisterTaskDefinitionlogonType パラメーターに TASK_LOGON_INTERACTIVE_TOKEN または TASK_LOGON_GROUP を指定します。

バッテリー節約機能が有効な場合、Windows タスクスケジューラのタスクは、次の条件を満たすタスクのみがトリガーされます。

その他のすべてのトリガーは、バッテリー節約機能が無効になるまで遅延されます。アプリケーションでバッテリー節約機能の状態にアクセスする方法の詳細については、SYSTEM_POWER_STATUS を参照してください。バッテリー節約機能に関する一般的な情報については、battery saver (in the hardware component guidelines) を参照してください。
vtbl 14 HRESULT put_LogonType(TASK_LOGON_TYPE logon)

プリンシパルに関連付けられたタスクの実行に必要なセキュリティログオン方法を取得または設定します。(Put)

logonTASK_LOGON_TYPEinタスク実行時に使用するログオン方法を TASK_LOGON_TYPE 値で指定する。

解説(Remarks)

このプロパティは、UserId プロパティによってユーザー識別子が指定されている場合にのみ有効です。

タスクの XML を読み書きする際、ログオンの種類は Task Scheduler スキーマの <LogonType> 要素で指定します。

メッセージボックスアクションを含むタスクの場合、タスクがアクティブ化され、そのタスクが対話型のログオンの種類を持っているときにメッセージボックスが表示されます。タスクのログオンの種類を対話型に設定するには、タスクプリンシパルの LogonType プロパティ、または ITaskFolder::RegisterTaskITaskFolder::RegisterTaskDefinitionlogonType パラメーターに TASK_LOGON_INTERACTIVE_TOKEN または TASK_LOGON_GROUP を指定します。

バッテリー節約機能が有効な場合、Windows タスクスケジューラのタスクは、次の条件を満たすタスクのみがトリガーされます。

その他のすべてのトリガーは、バッテリー節約機能が無効になるまで遅延されます。アプリケーションでバッテリー節約機能の状態にアクセスする方法の詳細については、SYSTEM_POWER_STATUS を参照してください。バッテリー節約機能に関する一般的な情報については、battery saver (in the hardware component guidelines) を参照してください。
vtbl 15 HRESULT get_GroupId(LPWSTR* pGroup)

プリンシパルに関連付けられたタスクの実行に必要なユーザーグループの識別子を取得または設定します。(Get)

pGroupLPWSTR*inoutタスクを実行するグループの ID を受け取る出力ポインタである。SysFreeString で解放する。

解説(Remarks)

UserId プロパティにユーザー識別子が指定されている場合は、このプロパティを設定しないでください。

タスクの XML を読み書きする際、プリンシパルのグループ識別子は Task Scheduler スキーマの GroupId 要素で指定します。

vtbl 16 HRESULT put_GroupId(LPWSTR group)

プリンシパルに関連付けられたタスクの実行に必要なユーザーグループの識別子を取得または設定します。(Put)

groupLPWSTRinタスクを実行するグループの ID を指定する。

解説(Remarks)

UserId プロパティにユーザー識別子が指定されている場合は、このプロパティを設定しないでください。

タスクの XML を読み書きする際、プリンシパルのグループ識別子は Task Scheduler スキーマの GroupId 要素で指定します。

vtbl 17 HRESULT get_RunLevel(TASK_RUNLEVEL_TYPE* pRunLevel)

プリンシパルに関連付けられたタスクの実行に必要な特権レベルを指定するために使用される識別子を取得または設定します。(Get)

pRunLevelTASK_RUNLEVEL_TYPE*inoutタスクが実行される権限レベルを表す TASK_RUNLEVEL_TYPE 値を受け取る変数へのポインタである。

解説(Remarks)

Builtin\Administrator アカウント、または Local System や Local Service アカウントを使用してタスクが登録された場合、RunLevel プロパティは無視されます。また、ユーザーアカウント制御 (UAC) が無効になっている場合も、このプロパティ値は無視されます。

タスクのセキュリティコンテキストに Administrators グループを使用してタスクが登録された場合、そのタスクを実行するには、RunLevel プロパティを TASK_RUNLEVEL_HIGHEST に設定する必要もあります。詳細については、Security Contexts for Tasks を参照してください。

vtbl 18 HRESULT put_RunLevel(TASK_RUNLEVEL_TYPE runLevel)

プリンシパルに関連付けられたタスクの実行に必要な特権レベルを指定するために使用される識別子を取得または設定します。(Put)

runLevelTASK_RUNLEVEL_TYPEinタスクが実行される権限レベルを TASK_RUNLEVEL_TYPE 値で指定する。

解説(Remarks)

Builtin\Administrator アカウント、または Local System や Local Service アカウントを使用してタスクが登録された場合、RunLevel プロパティは無視されます。また、ユーザーアカウント制御 (UAC) が無効になっている場合も、このプロパティ値は無視されます。

タスクのセキュリティコンテキストに Administrators グループを使用してタスクが登録された場合、そのタスクを実行するには、RunLevel プロパティを TASK_RUNLEVEL_HIGHEST に設定する必要もあります。詳細については、Security Contexts for Tasks を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IPrincipal "{D98D51E5-C9B4-496A-A9C1-18980261CF0F}"
#usecom global IPrincipal IID_IPrincipal "{}"
#comfunc global IPrincipal_get_Id           7 var
#comfunc global IPrincipal_put_Id           8 wstr
#comfunc global IPrincipal_get_DisplayName  9 var
#comfunc global IPrincipal_put_DisplayName  10 wstr
#comfunc global IPrincipal_get_UserId       11 var
#comfunc global IPrincipal_put_UserId       12 wstr
#comfunc global IPrincipal_get_LogonType    13 var
#comfunc global IPrincipal_put_LogonType    14 int
#comfunc global IPrincipal_get_GroupId      15 var
#comfunc global IPrincipal_put_GroupId      16 wstr
#comfunc global IPrincipal_get_RunLevel     17 var
#comfunc global IPrincipal_put_RunLevel     18 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。