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

IRegistrationInfo

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID416d8b73-cb41-4ea1-805c-9be9a5ac4a74継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

タスクを説明するために使用できる管理情報を提供します。

解説(Remarks)

登録情報は、タスク スケジューラ UI を通じてタスクを識別するために、または登録済みのタスクを列挙するときの検索条件として使用できます。

タスクの XML を読み書きするとき、タスクの登録情報はタスク スケジューラ スキーマの RegistrationInfo 要素で指定します。

例

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

メソッド 18

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

vtbl 7 HRESULT get_Description(LPWSTR* pDescription)

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

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

解説(Remarks)

タスクの XML を読み書きするとき、タスクの説明はタスク スケジューラ スキーマの Description 要素を使用して指定します。

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

vtbl 8 HRESULT put_Description(LPWSTR description)

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

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

解説(Remarks)

タスクの XML を読み書きするとき、タスクの説明はタスク スケジューラ スキーマの Description 要素を使用して指定します。

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

vtbl 9 HRESULT get_Author(LPWSTR* pAuthor)

タスクの作成者を取得または設定します。(Get)

pAuthorLPWSTR*inoutタスクの作成者名を受け取る文字列ポインタへのポインタである。

解説(Remarks)

タスクの XML を読み書きするとき、タスクの作成者はタスク スケジューラ スキーマの Author 要素を使用して指定します。

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

vtbl 10 HRESULT put_Author(LPWSTR author)

タスクの作成者を取得または設定します。(Put)

authorLPWSTRinタスクに設定する作成者名を指定する。

解説(Remarks)

タスクの XML を読み書きするとき、タスクの作成者はタスク スケジューラ スキーマの Author 要素を使用して指定します。

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

vtbl 11 HRESULT get_Version(LPWSTR* pVersion)

タスクのバージョン番号を取得または設定します。(Get)

pVersionLPWSTR*inoutタスクのバージョン文字列を受け取る文字列ポインタへのポインタである。

解説(Remarks)

タスクの XML を読み書きするとき、タスクのバージョン番号はタスク スケジューラ スキーマの Version 要素を使用して指定します。

vtbl 12 HRESULT put_Version(LPWSTR version)

タスクのバージョン番号を取得または設定します。(Put)

versionLPWSTRinタスクに設定するバージョン文字列を指定する。

解説(Remarks)

タスクの XML を読み書きするとき、タスクのバージョン番号はタスク スケジューラ スキーマの Version 要素を使用して指定します。

vtbl 13 HRESULT get_Date(LPWSTR* pDate)

タスクが登録された日時を取得または設定します。(Get)

pDateLPWSTR*inoutタスクの登録日時を表す文字列を受け取る文字列ポインタへのポインタである。

解説(Remarks)

タスクの XML を読み書きするとき、登録日はタスク スケジューラ スキーマの Date 要素を使用して指定します。

vtbl 14 HRESULT put_Date(LPWSTR date)

タスクが登録された日時を取得または設定します。(Put)

dateLPWSTRinタスクの登録日時を表す文字列を指定する。

解説(Remarks)

タスクの XML を読み書きするとき、登録日はタスク スケジューラ スキーマの Date 要素を使用して指定します。

vtbl 15 HRESULT get_Documentation(LPWSTR* pDocumentation)

タスクの追加ドキュメントを取得または設定します。(Get)

pDocumentationLPWSTR*inoutタスクに関するドキュメント情報を受け取る文字列ポインタへのポインタである。

解説(Remarks)

タスクの XML を読み書きするとき、タスクの追加ドキュメントはタスク スケジューラ スキーマの Documentation 要素を使用して指定します。

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

vtbl 16 HRESULT put_Documentation(LPWSTR documentation)

タスクの追加ドキュメントを取得または設定します。(Put)

documentationLPWSTRinタスクに設定するドキュメント情報を指定する。

解説(Remarks)

タスクの XML を読み書きするとき、タスクの追加ドキュメントはタスク スケジューラ スキーマの Documentation 要素を使用して指定します。

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

vtbl 17 HRESULT get_XmlText(LPWSTR* pText)

タスクの登録情報の XML 形式のバージョンを取得または設定します。(Get)

pTextLPWSTR*inout登録情報を表す XML テキストを受け取る文字列ポインタへのポインタである。
vtbl 18 HRESULT put_XmlText(LPWSTR text)

タスクの登録情報の XML 形式のバージョンを取得または設定します。(Put)

textLPWSTRin登録情報として設定する XML テキストを指定する。
vtbl 19 HRESULT get_URI(LPWSTR* pUri)

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

pUriLPWSTR*inoutタスクの URI を受け取る文字列ポインタへのポインタである。

解説(Remarks)

タスクの XML を読み書きするとき、タスクの URI はタスク スケジューラ スキーマの URI 要素を使用して指定します。

vtbl 20 HRESULT put_URI(LPWSTR uri)

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

uriLPWSTRinタスクに設定する URI を指定する。

解説(Remarks)

タスクの XML を読み書きするとき、タスクの URI はタスク スケジューラ スキーマの URI 要素を使用して指定します。

vtbl 21 HRESULT get_SecurityDescriptor(VARIANT* pSddl)

タスクのセキュリティ記述子を取得または設定します。(Get)

pSddlVARIANT*inoutタスクのセキュリティ記述子 (SDDL 文字列) を格納する VARIANT を受け取る出力先へのポインタである。

解説(Remarks)

タスクの XML を読み書きするとき、タスクのセキュリティ記述子はタスク スケジューラ スキーマの SecurityDescriptor 要素を使用して指定します。

タスクの登録時に別のセキュリティ記述子が指定された場合、それはこのプロパティを通じて設定される sddl パラメーターより優先されます。

無効なセキュリティ記述子を sddl パラメーターに渡そうとすると、このメソッドは E_INVALIDARG を返します。

vtbl 22 HRESULT put_SecurityDescriptor(VARIANT sddl)

タスクのセキュリティ記述子を取得または設定します。(Put)

sddlVARIANTinタスクに設定するセキュリティ記述子を SDDL 文字列として格納した VARIANT を指定する。

解説(Remarks)

タスクの XML を読み書きするとき、タスクのセキュリティ記述子はタスク スケジューラ スキーマの SecurityDescriptor 要素を使用して指定します。

タスクの登録時に別のセキュリティ記述子が指定された場合、それはこのプロパティを通じて設定される sddl パラメーターより優先されます。

無効なセキュリティ記述子を sddl パラメーターに渡そうとすると、このメソッドは E_INVALIDARG を返します。

vtbl 23 HRESULT get_Source(LPWSTR* pSource)

タスクの発生元を取得または設定します。たとえば、タスクはコンポーネント、サービス、アプリケーション、またはユーザーから発生する場合があります。(Get)

pSourceLPWSTR*inoutタスクの提供元 (ソース) を受け取る文字列ポインタへのポインタである。

解説(Remarks)

タスク スケジューラ UI は、タスクの並べ替えにソースを使用します。たとえば、タスクはコンポーネント、サービス、アプリケーション、またはユーザーで並べ替えることができます。

タスクの XML を読み書きするとき、タスクのソース情報はタスク スケジューラ スキーマの Source 要素を使用して指定します。

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

vtbl 24 HRESULT put_Source(LPWSTR source)

タスクの発生元を取得または設定します。たとえば、タスクはコンポーネント、サービス、アプリケーション、またはユーザーから発生する場合があります。(Put)

sourceLPWSTRinタスクに設定する提供元 (ソース) を指定する。

解説(Remarks)

タスク スケジューラ UI は、タスクの並べ替えにソースを使用します。たとえば、タスクはコンポーネント、サービス、アプリケーション、またはユーザーで並べ替えることができます。

タスクの XML を読み書きするとき、タスクのソース情報はタスク スケジューラ スキーマの Source 要素を使用して指定します。

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IRegistrationInfo "{416D8B73-CB41-4EA1-805C-9BE9A5AC4A74}"
#usecom global IRegistrationInfo IID_IRegistrationInfo "{}"
#comfunc global IRegistrationInfo_get_Description         7 var
#comfunc global IRegistrationInfo_put_Description         8 wstr
#comfunc global IRegistrationInfo_get_Author              9 var
#comfunc global IRegistrationInfo_put_Author              10 wstr
#comfunc global IRegistrationInfo_get_Version             11 var
#comfunc global IRegistrationInfo_put_Version             12 wstr
#comfunc global IRegistrationInfo_get_Date                13 var
#comfunc global IRegistrationInfo_put_Date                14 wstr
#comfunc global IRegistrationInfo_get_Documentation       15 var
#comfunc global IRegistrationInfo_put_Documentation       16 wstr
#comfunc global IRegistrationInfo_get_XmlText             17 var
#comfunc global IRegistrationInfo_put_XmlText             18 wstr
#comfunc global IRegistrationInfo_get_URI                 19 var
#comfunc global IRegistrationInfo_put_URI                 20 wstr
#comfunc global IRegistrationInfo_get_SecurityDescriptor  21 var
#comfunc global IRegistrationInfo_put_SecurityDescriptor  22 int
#comfunc global IRegistrationInfo_get_Source              23 var
#comfunc global IRegistrationInfo_put_Source              24 wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。