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

SRSetRestorePointA

関数
システムの復元ポイントを作成する(ANSI版)。
DLLsfc.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// sfc.dll  (ANSI / -A)
#include <windows.h>

BOOL SRSetRestorePointA(
    RESTOREPOINTINFOA* pRestorePtSpec,
    STATEMGRSTATUS* pSMgrStatus
);

パラメーター

名前型方向説明
pRestorePtSpecRESTOREPOINTINFOA*in復元ポイントを指定する RESTOREPOINTINFO 構造体へのポインターです。
pSMgrStatusSTATEMGRSTATUS*out状態情報を受け取る STATEMGRSTATUS 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

System Restore が復元ポイントを作成できるように、一連の変更の開始と終了を指定します。(ANSI)

戻り値

関数が成功した場合、戻り値は TRUE です。pSMgrStatus の llSequenceNumber メンバーは、復元ポイントのシーケンス番号を受け取ります。

関数が失敗した場合、戻り値は FALSE です。pSMgrStatus の nStatus メンバーは、エラー情報を受け取ります。

解説(Remarks)

SRSetRestorePoint を使用する任意のプロセスに対して NetworkService、LocalService、および System がコールバックできるように、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 の場合、System Restore は新しい復元ポイントの作成をスキップしません。

アプリケーションが SRSetRestorePoint を呼び出して復元ポイントを作成する際、このレジストリ キーの値が整数 N の場合、過去 N 分以内に復元ポイントが作成されていれば、System Restore は新しい復元ポイントの作成をスキップします。

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 の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// sfc.dll  (ANSI / -A)
#include <windows.h>

BOOL SRSetRestorePointA(
    RESTOREPOINTINFOA* pRestorePtSpec,
    STATEMGRSTATUS* pSMgrStatus
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("sfc.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool SRSetRestorePointA(
    IntPtr pRestorePtSpec,   // RESTOREPOINTINFOA*
    IntPtr pSMgrStatus   // STATEMGRSTATUS* out
);
<DllImport("sfc.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SRSetRestorePointA(
    pRestorePtSpec As IntPtr,   ' RESTOREPOINTINFOA*
    pSMgrStatus As IntPtr   ' STATEMGRSTATUS* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pRestorePtSpec : RESTOREPOINTINFOA*
' pSMgrStatus : STATEMGRSTATUS* out
Declare PtrSafe Function SRSetRestorePointA Lib "sfc" ( _
    ByVal pRestorePtSpec As LongPtr, _
    ByVal pSMgrStatus As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SRSetRestorePointA = ctypes.windll.sfc.SRSetRestorePointA
SRSetRestorePointA.restype = wintypes.BOOL
SRSetRestorePointA.argtypes = [
    ctypes.c_void_p,  # pRestorePtSpec : RESTOREPOINTINFOA*
    ctypes.c_void_p,  # pSMgrStatus : STATEMGRSTATUS* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('sfc.dll')
SRSetRestorePointA = Fiddle::Function.new(
  lib['SRSetRestorePointA'],
  [
    Fiddle::TYPE_VOIDP,  # pRestorePtSpec : RESTOREPOINTINFOA*
    Fiddle::TYPE_VOIDP,  # pSMgrStatus : STATEMGRSTATUS* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "sfc")]
extern "system" {
    fn SRSetRestorePointA(
        pRestorePtSpec: *mut RESTOREPOINTINFOA,  // RESTOREPOINTINFOA*
        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.Ansi)]
public static extern bool SRSetRestorePointA(IntPtr pRestorePtSpec, IntPtr pSMgrStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 'sfc_SRSetRestorePointA' -Namespace Win32 -PassThru
# $api::SRSetRestorePointA(pRestorePtSpec, pSMgrStatus)
#uselib "sfc.dll"
#func global SRSetRestorePointA "SRSetRestorePointA" sptr, sptr
; SRSetRestorePointA varptr(pRestorePtSpec), varptr(pSMgrStatus)   ; 戻り値は stat
; pRestorePtSpec : RESTOREPOINTINFOA* -> "sptr"
; pSMgrStatus : STATEMGRSTATUS* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "sfc.dll"
#cfunc global SRSetRestorePointA "SRSetRestorePointA" var, var
; res = SRSetRestorePointA(pRestorePtSpec, pSMgrStatus)
; pRestorePtSpec : RESTOREPOINTINFOA* -> "var"
; pSMgrStatus : STATEMGRSTATUS* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SRSetRestorePointA(RESTOREPOINTINFOA* pRestorePtSpec, STATEMGRSTATUS* pSMgrStatus)
#uselib "sfc.dll"
#cfunc global SRSetRestorePointA "SRSetRestorePointA" var, var
; res = SRSetRestorePointA(pRestorePtSpec, pSMgrStatus)
; pRestorePtSpec : RESTOREPOINTINFOA* -> "var"
; pSMgrStatus : STATEMGRSTATUS* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	sfc = windows.NewLazySystemDLL("sfc.dll")
	procSRSetRestorePointA = sfc.NewProc("SRSetRestorePointA")
)

// pRestorePtSpec (RESTOREPOINTINFOA*), pSMgrStatus (STATEMGRSTATUS* out)
r1, _, err := procSRSetRestorePointA.Call(
	uintptr(pRestorePtSpec),
	uintptr(pSMgrStatus),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SRSetRestorePointA(
  pRestorePtSpec: Pointer;   // RESTOREPOINTINFOA*
  pSMgrStatus: Pointer   // STATEMGRSTATUS* out
): BOOL; stdcall;
  external 'sfc.dll' name 'SRSetRestorePointA';
result := DllCall("sfc\SRSetRestorePointA"
    , "Ptr", pRestorePtSpec   ; RESTOREPOINTINFOA*
    , "Ptr", pSMgrStatus   ; STATEMGRSTATUS* out
    , "Int")   ; return: BOOL
●SRSetRestorePointA(pRestorePtSpec, pSMgrStatus) = DLL("sfc.dll", "bool SRSetRestorePointA(void*, void*)")
# 呼び出し: SRSetRestorePointA(pRestorePtSpec, pSMgrStatus)
# pRestorePtSpec : RESTOREPOINTINFOA* -> "void*"
# pSMgrStatus : STATEMGRSTATUS* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "sfc" fn SRSetRestorePointA(
    pRestorePtSpec: [*c]RESTOREPOINTINFOA, // RESTOREPOINTINFOA*
    pSMgrStatus: [*c]STATEMGRSTATUS // STATEMGRSTATUS* out
) callconv(std.os.windows.WINAPI) i32;
proc SRSetRestorePointA(
    pRestorePtSpec: ptr RESTOREPOINTINFOA,  # RESTOREPOINTINFOA*
    pSMgrStatus: ptr STATEMGRSTATUS  # STATEMGRSTATUS* out
): int32 {.importc: "SRSetRestorePointA", stdcall, dynlib: "sfc.dll".}
pragma(lib, "sfc");
extern(Windows)
int SRSetRestorePointA(
    RESTOREPOINTINFOA* pRestorePtSpec,   // RESTOREPOINTINFOA*
    STATEMGRSTATUS* pSMgrStatus   // STATEMGRSTATUS* out
);
ccall((:SRSetRestorePointA, "sfc.dll"), stdcall, Int32,
      (Ptr{RESTOREPOINTINFOA}, Ptr{STATEMGRSTATUS}),
      pRestorePtSpec, pSMgrStatus)
# pRestorePtSpec : RESTOREPOINTINFOA* -> Ptr{RESTOREPOINTINFOA}
# pSMgrStatus : STATEMGRSTATUS* out -> Ptr{STATEMGRSTATUS}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SRSetRestorePointA(
    void* pRestorePtSpec,
    void* pSMgrStatus);
]]
local sfc = ffi.load("sfc")
-- sfc.SRSetRestorePointA(pRestorePtSpec, pSMgrStatus)
-- pRestorePtSpec : RESTOREPOINTINFOA*
-- pSMgrStatus : STATEMGRSTATUS* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('sfc.dll');
const SRSetRestorePointA = lib.func('__stdcall', 'SRSetRestorePointA', 'int32_t', ['void *', 'void *']);
// SRSetRestorePointA(pRestorePtSpec, pSMgrStatus)
// pRestorePtSpec : RESTOREPOINTINFOA* -> 'void *'
// pSMgrStatus : STATEMGRSTATUS* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("sfc.dll", {
  SRSetRestorePointA: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.SRSetRestorePointA(pRestorePtSpec, pSMgrStatus)
// pRestorePtSpec : RESTOREPOINTINFOA* -> "pointer"
// pSMgrStatus : STATEMGRSTATUS* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SRSetRestorePointA(
    void* pRestorePtSpec,
    void* pSMgrStatus);
C, "sfc.dll");
// $ffi->SRSetRestorePointA(pRestorePtSpec, pSMgrStatus);
// pRestorePtSpec : RESTOREPOINTINFOA*
// 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.ASCII_OPTIONS);
    boolean SRSetRestorePointA(
        Pointer pRestorePtSpec,   // RESTOREPOINTINFOA*
        Pointer pSMgrStatus   // STATEMGRSTATUS* out
    );
}
@[Link("sfc")]
lib Libsfc
  fun SRSetRestorePointA = SRSetRestorePointA(
    pRestorePtSpec : RESTOREPOINTINFOA*,   # RESTOREPOINTINFOA*
    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 SRSetRestorePointANative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef SRSetRestorePointADart = int Function(Pointer<Void>, Pointer<Void>);
final SRSetRestorePointA = DynamicLibrary.open('sfc.dll')
    .lookupFunction<SRSetRestorePointANative, SRSetRestorePointADart>('SRSetRestorePointA');
// pRestorePtSpec : RESTOREPOINTINFOA* -> Pointer<Void>
// pSMgrStatus : STATEMGRSTATUS* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SRSetRestorePointA(
  pRestorePtSpec: Pointer;   // RESTOREPOINTINFOA*
  pSMgrStatus: Pointer   // STATEMGRSTATUS* out
): BOOL; stdcall;
  external 'sfc.dll' name 'SRSetRestorePointA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SRSetRestorePointA"
  c_SRSetRestorePointA :: Ptr () -> Ptr () -> IO CInt
-- pRestorePtSpec : RESTOREPOINTINFOA* -> Ptr ()
-- pSMgrStatus : STATEMGRSTATUS* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let srsetrestorepointa =
  foreign "SRSetRestorePointA"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* pRestorePtSpec : RESTOREPOINTINFOA* -> (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 ("SRSetRestorePointA" srset-restore-point-a :convention :stdcall) :int32
  (p-restore-pt-spec :pointer)   ; RESTOREPOINTINFOA*
  (p-smgr-status :pointer))   ; STATEMGRSTATUS* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SRSetRestorePointA = Win32::API::More->new('sfc',
    'BOOL SRSetRestorePointA(LPVOID pRestorePtSpec, LPVOID pSMgrStatus)');
# my $ret = $SRSetRestorePointA->Call($pRestorePtSpec, $pSMgrStatus);
# pRestorePtSpec : RESTOREPOINTINFOA* -> LPVOID
# pSMgrStatus : STATEMGRSTATUS* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目
使用する型