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

IGPMBackup

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

公式ドキュメント

IGPMBackup インターフェイスは、GPMBackup オブジェクトを削除したり、GPMBackup オブジェクトのさまざまなプロパティを取得したりするためのメソッドを提供します。

メソッド 10

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

vtbl 7 HRESULT get_ID(LPWSTR* pVal)
pValLPWSTR*outこのバックアップの ID を受け取るポインタである。
vtbl 8 HRESULT get_GPOID(LPWSTR* pVal)
pValLPWSTR*outバックアップ元の GPO の ID を受け取るポインタである。
vtbl 9 HRESULT get_GPODomain(LPWSTR* pVal)
pValLPWSTR*outバックアップ元の GPO が属するドメイン名を受け取るポインタである。
vtbl 10 HRESULT get_GPODisplayName(LPWSTR* pVal)
pValLPWSTR*outバックアップ元の GPO の表示名を受け取るポインタである。
vtbl 11 HRESULT get_Timestamp(DOUBLE* pVal)
pValDOUBLE*outバックアップが作成された日時を受け取る DOUBLE へのポインタである。
vtbl 12 HRESULT get_Comment(LPWSTR* pVal)
pValLPWSTR*outバックアップに付与されたコメントを受け取るポインタである。
vtbl 13 HRESULT get_BackupDir(LPWSTR* pVal)
pValLPWSTR*outこのバックアップが格納されているディレクトリのパスを受け取るポインタである。
vtbl 14 HRESULT Delete()

バックアップディレクトリおよびファイルシステムから、グループポリシーオブジェクト (GPO) のバックアップを削除します。

戻り値

JScript

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

VB

成功した場合は S_OK を返します。エラーが発生した場合は失敗コードを返します。
vtbl 15 HRESULT GenerateReport(GPMReportType gpmReportType, VARIANT* pvarGPMProgress, VARIANT* pvarGPMCancel, IGPMResult** ppIGPMResult)

バックアップされたグループポリシーオブジェクト (GPO) のレポートを取得します。

gpmReportTypeGPMReportTypeinレポートを XML と HTML のどちらの形式にするかを指定します。
pvarGPMProgressVARIANT*inIGPMAsyncProgress インターフェイスへのポインターです。pvarGPMProgress が NULL の場合、GenerateReport の呼び出しは同期的に処理されます。NULL でない場合、GenerateReport の呼び出しは非同期的に処理され、pvarGPMCancel に IGPMAsyncCancel へのポインターが返されます。
pvarGPMCancelVARIANT*outIGPMAsyncCancel インターフェイスへのポインターです。このパラメーターの値は、pvarGPMProgress が指定され、かつ NULL でない場合にのみ返されます。
ppIGPMResultIGPMResult**outIGPMResult インターフェイスへのポインターです。Result プロパティには XML または HTML の文字列が格納されます。Status プロパティには IGPMStatusMsgCollection インターフェイスへの参照が格納されます。

戻り値

C++

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

JScript

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

VB

GPMResult オブジェクトへの参照を返します。
vtbl 16 HRESULT GenerateReportToFile(GPMReportType gpmReportType, LPWSTR bstrTargetFilePath, IGPMResult** ppIGPMResult)

GenerateReportToFile メソッドは、バックアップされたグループポリシーオブジェクト (GPO) のレポートを取得し、指定したパスのファイルにそのレポートを保存します。

gpmReportTypeGPMReportTypeinレポートを XML と HTML のどちらの形式にするかを指定します。
bstrTargetFilePathLPWSTRinレポートの保存先ファイルのパスを格納するバイナリ文字列です。null 終端文字列を使用してください。
ppIGPMResultIGPMResult**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_IGPMBackup "{D8A16A35-3B0D-416B-8D02-4DF6F95A7119}"
#usecom global IGPMBackup IID_IGPMBackup "{}"
#comfunc global IGPMBackup_get_ID                7 var
#comfunc global IGPMBackup_get_GPOID             8 var
#comfunc global IGPMBackup_get_GPODomain         9 var
#comfunc global IGPMBackup_get_GPODisplayName    10 var
#comfunc global IGPMBackup_get_Timestamp         11 var
#comfunc global IGPMBackup_get_Comment           12 var
#comfunc global IGPMBackup_get_BackupDir         13 var
#comfunc global IGPMBackup_Delete                14
#comfunc global IGPMBackup_GenerateReport        15 int,var,var,sptr
#comfunc global IGPMBackup_GenerateReportToFile  16 int,wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。