ホーム › System.GroupPolicy › IGPMStarterGPOBackup

IGPMStarterGPOBackup

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID51d98eda-a87e-43dd-b80a-0b66ef1938d6継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IGPMStarterGPOBackup インターフェイスは、GPMStarterGPOBackup オブジェクトの削除や、GPMStarterGPOBackup オブジェクトの各種プロパティの取得を行うメソッドを提供します。

メソッド 11

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

vtbl 7 HRESULT get_BackupDir(LPWSTR* pbstrBackupDir)

pbstrBackupDir

LPWSTR*

out

このスターター GPO バックアップが格納されているバックアップディレクトリのパスを受け取る文字列ポインタである。

vtbl 8 HRESULT get_Comment(LPWSTR* pbstrComment)

pbstrComment

LPWSTR*

out

バックアップ作成時に付与されたコメントを受け取る文字列ポインタである。

vtbl 9 HRESULT get_DisplayName(LPWSTR* pbstrDisplayName)

pbstrDisplayName

LPWSTR*

out

バックアップされたスターター GPO の表示名を受け取る文字列ポインタである。

vtbl 10 HRESULT get_Domain(LPWSTR* pbstrTemplateDomain)

pbstrTemplateDomain

LPWSTR*

out

スターター GPO が属していたドメインの名前を受け取る文字列ポインタである。

vtbl 11 HRESULT get_StarterGPOID(LPWSTR* pbstrTemplateID)

pbstrTemplateID

LPWSTR*

out

バックアップ元のスターター GPO の ID (GUID) を受け取る文字列ポインタである。

vtbl 12 HRESULT get_ID(LPWSTR* pbstrID)

pbstrID

LPWSTR*

out

このバックアップ自体の ID (GUID) を受け取る文字列ポインタである。

vtbl 13 HRESULT get_Timestamp(DOUBLE* pTimestamp)

pTimestamp

DOUBLE*

out

バックアップが作成された日時を表すタイムスタンプ (DATE 値) を受け取る。

vtbl 14 HRESULT get_Type(GPMStarterGPOType* pType)

pType

GPMStarterGPOType*

out

スターター GPO の種別を表す GPMStarterGPOType 値を受け取る。

vtbl 15 HRESULT Delete()

バックアップディレクトリおよびファイルシステムから、スターター GPO のバックアップを削除します。

戻り値

JScript

成功した場合は S_OK を返します。エラーが発生した場合は失敗コードを返します。

VB

成功した場合は S_OK を返します。エラーが発生した場合は失敗コードを返します。

vtbl 16 HRESULT GenerateReport(GPMReportType gpmReportType, VARIANT* pvarGPMProgress, VARIANT* pvarGPMCancel, IGPMResult** ppIGPMResult)

GenerateReport メソッドは、バックアップされた GPO のレポートを取得します。

gpmReportType	GPMReportType	in	レポートの形式が XML か HTML かを指定します。
pvarGPMProgress	VARIANT*	in	IGPMAsyncProgress インターフェイスへのポインター。pvarGPMProgress が null の場合、GenerateReport の呼び出しは同期的に処理されます。null でない場合、GenerateReport の呼び出しは非同期に処理され、pvarGPMCancel に IGPMAsyncCancel へのポインターが返されます。
pvarGPMCancel	VARIANT*	out	IGPMAsyncCancel インターフェイスへのポインター。このパラメーターの値は、pvarGPMProgress が指定され、かつ null でない場合にのみ返されます。
ppIGPMResult	IGPMResult**	out	IGPMResult へのポインター。Result プロパティには XML または HTML の文字列が格納されます。Status プロパティには IGPMStatusMsgCollection への参照が格納されます。

戻り値

C++

成功した場合は S_OK を返します。エラーが発生した場合は失敗コードを返します。

JScript

GPMResult オブジェクトへの参照を返します。

VB

GPMResult オブジェクトへの参照を返します。

vtbl 17 HRESULT GenerateReportToFile(GPMReportType gpmReportType, LPWSTR bstrTargetFilePath, IGPMResult** ppIGPMResult)

GenerateReportToFile は、バックアップされたスターター GPO のレポートを取得し、指定したパスのファイルに保存します。

gpmReportType	GPMReportType	in	レポートの形式が XML か HTML かを指定します。
bstrTargetFilePath	LPWSTR	in	レポートの保存先ファイルのパスを格納するバイナリ文字列。null 終端文字列を使用してください。
ppIGPMResult	IGPMResult**	out	IGPMResult インターフェイスへのポインター。Status プロパティには IGPMStatusMsgCollection への参照が格納されます。メモ Result プロパティの値は不定であり、依存すべきではありません。

戻り値

C++

成功した場合は S_OK を返します。エラーが発生した場合は失敗コードを返します。

JScript

GPMResult オブジェクトへの参照を返します。

メモ Result プロパティの値は不定であり、依存すべきではありません。

VB

GPMResult オブジェクトへの参照を返します。

メモ Result プロパティの値は不定であり、依存すべきではありません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IGPMStarterGPOBackup "{51D98EDA-A87E-43DD-B80A-0B66EF1938D6}"
#usecom global IGPMStarterGPOBackup IID_IGPMStarterGPOBackup "{}"
#comfunc global IGPMStarterGPOBackup_get_BackupDir         7 var
#comfunc global IGPMStarterGPOBackup_get_Comment           8 var
#comfunc global IGPMStarterGPOBackup_get_DisplayName       9 var
#comfunc global IGPMStarterGPOBackup_get_Domain            10 var
#comfunc global IGPMStarterGPOBackup_get_StarterGPOID      11 var
#comfunc global IGPMStarterGPOBackup_get_ID                12 var
#comfunc global IGPMStarterGPOBackup_get_Timestamp         13 var
#comfunc global IGPMStarterGPOBackup_get_Type              14 var
#comfunc global IGPMStarterGPOBackup_Delete                15
#comfunc global IGPMStarterGPOBackup_GenerateReport        16 int,var,var,sptr
#comfunc global IGPMStarterGPOBackup_GenerateReportToFile  17 int,wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IGPMStarterGPOBackup "{51D98EDA-A87E-43DD-B80A-0B66EF1938D6}"
#usecom global IGPMStarterGPOBackup IID_IGPMStarterGPOBackup "{}"
#comfunc global IGPMStarterGPOBackup_get_BackupDir         7 sptr
#comfunc global IGPMStarterGPOBackup_get_Comment           8 sptr
#comfunc global IGPMStarterGPOBackup_get_DisplayName       9 sptr
#comfunc global IGPMStarterGPOBackup_get_Domain            10 sptr
#comfunc global IGPMStarterGPOBackup_get_StarterGPOID      11 sptr
#comfunc global IGPMStarterGPOBackup_get_ID                12 sptr
#comfunc global IGPMStarterGPOBackup_get_Timestamp         13 sptr
#comfunc global IGPMStarterGPOBackup_get_Type              14 sptr
#comfunc global IGPMStarterGPOBackup_Delete                15
#comfunc global IGPMStarterGPOBackup_GenerateReport        16 int,sptr,sptr,sptr
#comfunc global IGPMStarterGPOBackup_GenerateReportToFile  17 int,wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。