SRSetRestorePointW
関数シグネチャ
// sfc.dll (Unicode / -W)
#include <windows.h>
BOOL SRSetRestorePointW(
RESTOREPOINTINFOW* pRestorePtSpec,
STATEMGRSTATUS* pSMgrStatus
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pRestorePtSpec | RESTOREPOINTINFOW* | in | 復元ポイントを指定する RESTOREPOINTINFO 構造体へのポインター。 |
| pSMgrStatus | STATEMGRSTATUS* | out | 状態情報を受け取る STATEMGRSTATUS 構造体へのポインター。 |
戻り値の型: BOOL
公式ドキュメント
System Restore が復元ポイントを作成できるように、一連の変更の開始と終了を指定します。(Unicode)
戻り値
関数が成功した場合、戻り値は TRUE です。pSMgrStatus の llSequenceNumber メンバーは、復元ポイントのシーケンス番号を受け取ります。
関数が失敗した場合、戻り値は FALSE です。pSMgrStatus の nStatus メンバーは、エラー情報を受け取ります。
解説(Remarks)
NetworkService、LocalService、および System が SRSetRestorePoint を使用するプロセスに対してコールバックできるように、COM セキュリティを初期化する必要があります。これは SRSetRestorePoint が正しく動作するために必要です。CoInitializeEx および CoInitializeSecurity への COM 呼び出しの設定については、Using System Restore を参照してください。
この関数はセーフモードでは呼び出せません。また、System Restore が無効になっている場合にも失敗します( Disable を参照)。
この関数を呼び出すと、System Restore はレジストリおよびその他のシステムデータベースの完全なスナップショットを取得します。
アプリケーションは、ロード時の動的リンクを使用して System Restore の関数を呼び出さないでください。代わりに、LoadLibrary 関数を使用して SrClient.dll を読み込み、GetProcAddress を使用して関数を呼び出してください。
復元ポイントは、システムの変更を行う直前に、 RESTOREPOINTINFO 構造体の dwEventType メンバーに BEGIN_SYSTEM_CHANGE を設定して SRSetRestorePoint を呼び出すことで作成します。システムへの変更が完了したら、dwEventType に END_SYSTEM_CHANGE を設定して SRSetRestorePoint を呼び出します。
ユーザーがアプリケーションのインストールをキャンセルした場合、インストーラーはインストール開始時に作成した復元ポイントを削除できます。復元ポイントの削除は任意であり、削除すると、キャンセル処理中にインストーラーが行った意図しない変更からユーザーが回復できなくなる可能性があります。インストーラーが復元ポイントを削除する場合は、 SRRemoveRestorePoint 関数を呼び出すか、dwRestorePointType に CANCELLED_OPERATION、dwEventType に END_SYSTEM_CHANGE、llSequenceNumber に最初の SRSetRestorePoint の呼び出しで返された値を設定して SRSetRestorePoint を呼び出します。
SRSetRestorePoint を入れ子にして呼び出す場合は注意してください。詳細については、 Nested calls to SRSetRestorePoint を参照してください。
Windows 8:
アプリケーション開発者が復元ポイントの作成頻度を変更できる、新しいレジストリキーが用意されています。
このキーはシステムにあらかじめ存在しないため、使用するにはアプリケーションで作成する必要があります。キーが存在しない場合は、既定で次の動作になります。アプリケーションが SRSetRestorePoint 関数を呼び出して復元ポイントを作成しようとしても、過去 24 時間以内に復元ポイントが作成されている場合、Windows はこの新しい復元ポイントの作成をスキップします。System Restore は、STATEMGRSTATUS 構造体の IISequenceNumber メンバーに、その日のうちに以前作成された復元ポイントのシーケンス番号を設定し、nStatus メンバーの値を ERROR_SUCCESS に設定します。
SRSetRestorePoint 関数は TRUE を返します。
開発者は、レジストリキー HKLM\Software\Microsoft\Windows NT\CurrentVersion\SystemRestore の下に DWORD 値 SystemRestorePointCreationFrequency を作成するアプリケーションを記述できます。このレジストリキーの値によって、復元ポイントの作成頻度を変更できます。
アプリケーションが SRSetRestorePoint を呼び出して復元ポイントを作成する場合、このレジストリキーの値が 0 であれば、システムの復元は新しい復元ポイントの作成をスキップしません。
アプリケーションが SRSetRestorePoint を呼び出して復元ポイントを作成する場合、このレジストリキーの値が整数 N であれば、直前の N 分以内に復元ポイントが作成されていると、システムの復元は新しい復元ポイントの作成をスキップします。
Windows 8:
Windows 8 上で動作する System Restore は、ブートボリューム内のファイルのうち、システムの復元に関連するもののみを監視します。Windows 8 上で動作する System Restore が作成したブートボリュームのスナップショットは、そのスナップショットが後により古いバージョンの Windows によって公開された場合、削除されることがあります。システムボリュームは 1 つだけですが、マルチブートシステムではオペレーティングシステムごとに 1 つのブートボリュームが存在することに注意してください。
開発者は、レジストリキー HKLM\Software\Microsoft\Windows NT\CurrentVersion\SystemRestore の下に DWORD 値 ScopeSnapshots を作成するアプリケーションを記述できます。このレジストリキーの値が 0 の場合、System Restore は以前のバージョンの Windows と同じ方法でブートボリュームのスナップショットを作成します。この値が削除された場合、Windows 8 上で動作する System Restore は、ブートボリューム内のファイルのうちシステムの復元に関連するもののみを監視するスナップショットの作成を再開します。
例
例については、Using System Restore を参照してください。
srrestoreptapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SRSetRestorePoint を定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーや実行時エラーの原因となる不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// sfc.dll (Unicode / -W)
#include <windows.h>
BOOL SRSetRestorePointW(
RESTOREPOINTINFOW* pRestorePtSpec,
STATEMGRSTATUS* pSMgrStatus
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("sfc.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool SRSetRestorePointW(
IntPtr pRestorePtSpec, // RESTOREPOINTINFOW*
IntPtr pSMgrStatus // STATEMGRSTATUS* out
);<DllImport("sfc.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SRSetRestorePointW(
pRestorePtSpec As IntPtr, ' RESTOREPOINTINFOW*
pSMgrStatus As IntPtr ' STATEMGRSTATUS* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' pRestorePtSpec : RESTOREPOINTINFOW*
' pSMgrStatus : STATEMGRSTATUS* out
Declare PtrSafe Function SRSetRestorePointW Lib "sfc" ( _
ByVal pRestorePtSpec As LongPtr, _
ByVal pSMgrStatus As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SRSetRestorePointW = ctypes.windll.sfc.SRSetRestorePointW
SRSetRestorePointW.restype = wintypes.BOOL
SRSetRestorePointW.argtypes = [
ctypes.c_void_p, # pRestorePtSpec : RESTOREPOINTINFOW*
ctypes.c_void_p, # pSMgrStatus : STATEMGRSTATUS* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('sfc.dll')
SRSetRestorePointW = Fiddle::Function.new(
lib['SRSetRestorePointW'],
[
Fiddle::TYPE_VOIDP, # pRestorePtSpec : RESTOREPOINTINFOW*
Fiddle::TYPE_VOIDP, # pSMgrStatus : STATEMGRSTATUS* out
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "sfc")]
extern "system" {
fn SRSetRestorePointW(
pRestorePtSpec: *mut RESTOREPOINTINFOW, // RESTOREPOINTINFOW*
pSMgrStatus: *mut STATEMGRSTATUS // STATEMGRSTATUS* out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("sfc.dll", CharSet = CharSet.Unicode)]
public static extern bool SRSetRestorePointW(IntPtr pRestorePtSpec, IntPtr pSMgrStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 'sfc_SRSetRestorePointW' -Namespace Win32 -PassThru
# $api::SRSetRestorePointW(pRestorePtSpec, pSMgrStatus)#uselib "sfc.dll"
#func global SRSetRestorePointW "SRSetRestorePointW" wptr, wptr
; SRSetRestorePointW varptr(pRestorePtSpec), varptr(pSMgrStatus) ; 戻り値は stat
; pRestorePtSpec : RESTOREPOINTINFOW* -> "wptr"
; pSMgrStatus : STATEMGRSTATUS* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "sfc.dll" #cfunc global SRSetRestorePointW "SRSetRestorePointW" var, var ; res = SRSetRestorePointW(pRestorePtSpec, pSMgrStatus) ; pRestorePtSpec : RESTOREPOINTINFOW* -> "var" ; pSMgrStatus : STATEMGRSTATUS* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "sfc.dll" #cfunc global SRSetRestorePointW "SRSetRestorePointW" sptr, sptr ; res = SRSetRestorePointW(varptr(pRestorePtSpec), varptr(pSMgrStatus)) ; pRestorePtSpec : RESTOREPOINTINFOW* -> "sptr" ; pSMgrStatus : STATEMGRSTATUS* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; BOOL SRSetRestorePointW(RESTOREPOINTINFOW* pRestorePtSpec, STATEMGRSTATUS* pSMgrStatus) #uselib "sfc.dll" #cfunc global SRSetRestorePointW "SRSetRestorePointW" var, var ; res = SRSetRestorePointW(pRestorePtSpec, pSMgrStatus) ; pRestorePtSpec : RESTOREPOINTINFOW* -> "var" ; pSMgrStatus : STATEMGRSTATUS* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL SRSetRestorePointW(RESTOREPOINTINFOW* pRestorePtSpec, STATEMGRSTATUS* pSMgrStatus) #uselib "sfc.dll" #cfunc global SRSetRestorePointW "SRSetRestorePointW" intptr, intptr ; res = SRSetRestorePointW(varptr(pRestorePtSpec), varptr(pSMgrStatus)) ; pRestorePtSpec : RESTOREPOINTINFOW* -> "intptr" ; pSMgrStatus : STATEMGRSTATUS* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
sfc = windows.NewLazySystemDLL("sfc.dll")
procSRSetRestorePointW = sfc.NewProc("SRSetRestorePointW")
)
// pRestorePtSpec (RESTOREPOINTINFOW*), pSMgrStatus (STATEMGRSTATUS* out)
r1, _, err := procSRSetRestorePointW.Call(
uintptr(pRestorePtSpec),
uintptr(pSMgrStatus),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SRSetRestorePointW(
pRestorePtSpec: Pointer; // RESTOREPOINTINFOW*
pSMgrStatus: Pointer // STATEMGRSTATUS* out
): BOOL; stdcall;
external 'sfc.dll' name 'SRSetRestorePointW';result := DllCall("sfc\SRSetRestorePointW"
, "Ptr", pRestorePtSpec ; RESTOREPOINTINFOW*
, "Ptr", pSMgrStatus ; STATEMGRSTATUS* out
, "Int") ; return: BOOL●SRSetRestorePointW(pRestorePtSpec, pSMgrStatus) = DLL("sfc.dll", "bool SRSetRestorePointW(void*, void*)")
# 呼び出し: SRSetRestorePointW(pRestorePtSpec, pSMgrStatus)
# pRestorePtSpec : RESTOREPOINTINFOW* -> "void*"
# pSMgrStatus : STATEMGRSTATUS* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "sfc" fn SRSetRestorePointW(
pRestorePtSpec: [*c]RESTOREPOINTINFOW, // RESTOREPOINTINFOW*
pSMgrStatus: [*c]STATEMGRSTATUS // STATEMGRSTATUS* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc SRSetRestorePointW(
pRestorePtSpec: ptr RESTOREPOINTINFOW, # RESTOREPOINTINFOW*
pSMgrStatus: ptr STATEMGRSTATUS # STATEMGRSTATUS* out
): int32 {.importc: "SRSetRestorePointW", stdcall, dynlib: "sfc.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "sfc");
extern(Windows)
int SRSetRestorePointW(
RESTOREPOINTINFOW* pRestorePtSpec, // RESTOREPOINTINFOW*
STATEMGRSTATUS* pSMgrStatus // STATEMGRSTATUS* out
);ccall((:SRSetRestorePointW, "sfc.dll"), stdcall, Int32,
(Ptr{RESTOREPOINTINFOW}, Ptr{STATEMGRSTATUS}),
pRestorePtSpec, pSMgrStatus)
# pRestorePtSpec : RESTOREPOINTINFOW* -> Ptr{RESTOREPOINTINFOW}
# pSMgrStatus : STATEMGRSTATUS* out -> Ptr{STATEMGRSTATUS}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t SRSetRestorePointW(
void* pRestorePtSpec,
void* pSMgrStatus);
]]
local sfc = ffi.load("sfc")
-- sfc.SRSetRestorePointW(pRestorePtSpec, pSMgrStatus)
-- pRestorePtSpec : RESTOREPOINTINFOW*
-- pSMgrStatus : STATEMGRSTATUS* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('sfc.dll');
const SRSetRestorePointW = lib.func('__stdcall', 'SRSetRestorePointW', 'int32_t', ['void *', 'void *']);
// SRSetRestorePointW(pRestorePtSpec, pSMgrStatus)
// pRestorePtSpec : RESTOREPOINTINFOW* -> 'void *'
// pSMgrStatus : STATEMGRSTATUS* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("sfc.dll", {
SRSetRestorePointW: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.SRSetRestorePointW(pRestorePtSpec, pSMgrStatus)
// pRestorePtSpec : RESTOREPOINTINFOW* -> "pointer"
// pSMgrStatus : STATEMGRSTATUS* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SRSetRestorePointW(
void* pRestorePtSpec,
void* pSMgrStatus);
C, "sfc.dll");
// $ffi->SRSetRestorePointW(pRestorePtSpec, pSMgrStatus);
// pRestorePtSpec : RESTOREPOINTINFOW*
// pSMgrStatus : STATEMGRSTATUS* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Sfc extends StdCallLibrary {
Sfc INSTANCE = Native.load("sfc", Sfc.class, W32APIOptions.UNICODE_OPTIONS);
boolean SRSetRestorePointW(
Pointer pRestorePtSpec, // RESTOREPOINTINFOW*
Pointer pSMgrStatus // STATEMGRSTATUS* out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("sfc")]
lib Libsfc
fun SRSetRestorePointW = SRSetRestorePointW(
pRestorePtSpec : RESTOREPOINTINFOW*, # RESTOREPOINTINFOW*
pSMgrStatus : STATEMGRSTATUS* # STATEMGRSTATUS* out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SRSetRestorePointWNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef SRSetRestorePointWDart = int Function(Pointer<Void>, Pointer<Void>);
final SRSetRestorePointW = DynamicLibrary.open('sfc.dll')
.lookupFunction<SRSetRestorePointWNative, SRSetRestorePointWDart>('SRSetRestorePointW');
// pRestorePtSpec : RESTOREPOINTINFOW* -> Pointer<Void>
// pSMgrStatus : STATEMGRSTATUS* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SRSetRestorePointW(
pRestorePtSpec: Pointer; // RESTOREPOINTINFOW*
pSMgrStatus: Pointer // STATEMGRSTATUS* out
): BOOL; stdcall;
external 'sfc.dll' name 'SRSetRestorePointW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SRSetRestorePointW"
c_SRSetRestorePointW :: Ptr () -> Ptr () -> IO CInt
-- pRestorePtSpec : RESTOREPOINTINFOW* -> Ptr ()
-- pSMgrStatus : STATEMGRSTATUS* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let srsetrestorepointw =
foreign "SRSetRestorePointW"
((ptr void) @-> (ptr void) @-> returning int32_t)
(* pRestorePtSpec : RESTOREPOINTINFOW* -> (ptr void) *)
(* pSMgrStatus : STATEMGRSTATUS* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library sfc (t "sfc.dll"))
(cffi:use-foreign-library sfc)
(cffi:defcfun ("SRSetRestorePointW" srset-restore-point-w :convention :stdcall) :int32
(p-restore-pt-spec :pointer) ; RESTOREPOINTINFOW*
(p-smgr-status :pointer)) ; STATEMGRSTATUS* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SRSetRestorePointW = Win32::API::More->new('sfc',
'BOOL SRSetRestorePointW(LPVOID pRestorePtSpec, LPVOID pSMgrStatus)');
# my $ret = $SRSetRestorePointW->Call($pRestorePtSpec, $pSMgrStatus);
# pRestorePtSpec : RESTOREPOINTINFOW* -> LPVOID
# pSMgrStatus : STATEMGRSTATUS* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f SRSetRestorePointA (ANSI版) — システムの復元ポイントを作成する(ANSI版)。
- f SRRemoveRestorePoint — 指定した復元ポイントを削除する。