RegSaveKeyA

関数

指定キーとサブキーをファイルに保存する。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR RegSaveKeyA(
    HKEY hKey,
    LPCSTR lpFile,
    const SECURITY_ATTRIBUTES* lpSecurityAttributes   // optional
);

パラメーター

名前	型	方向	説明
hKey	HKEY	in	オープンされているレジストリキーへのハンドル。このハンドルは RegCreateKeyEx または RegOpenKeyEx 関数によって返されます。または、次のいずれかの定義済みキーを指定することもできます。 HKEY_CLASSES_ROOT HKEY_CURRENT_USER
lpFile	LPCSTR	in	指定したキーとサブキーの保存先となるファイルの名前。ファイルが既に存在する場合、この関数は失敗します。文字列にパスが含まれていない場合、ローカルキーではこのファイルは呼び出し元プロセスのカレントディレクトリに作成され、リモートキーでは %systemroot%\system32 ディレクトリに作成されます。新しいファイルにはアーカイブ属性が設定されます。
lpSecurityAttributes	SECURITY_ATTRIBUTES*	inoptional	新しいファイルのセキュリティ記述子を指定する SECURITY_ATTRIBUTES 構造体へのポインター。lpSecurityAttributes が NULL の場合、ファイルには既定のセキュリティ記述子が設定されます。ファイルの既定のセキュリティ記述子内の ACL は、その親ディレクトリから継承されます。

名前

型

方向

説明

hKey

HKEY

オープンされているレジストリキーへのハンドル。

このハンドルは RegCreateKeyEx または RegOpenKeyEx 関数によって返されます。または、次のいずれかの定義済みキーを指定することもできます。

HKEY_CLASSES_ROOT

HKEY_CURRENT_USER

lpFile

LPCSTR

指定したキーとサブキーの保存先となるファイルの名前。ファイルが既に存在する場合、この関数は失敗します。

文字列にパスが含まれていない場合、ローカルキーではこのファイルは呼び出し元プロセスのカレントディレクトリに作成され、リモートキーでは %systemroot%\system32 ディレクトリに作成されます。新しいファイルにはアーカイブ属性が設定されます。

lpSecurityAttributes

SECURITY_ATTRIBUTES*

inoptional

新しいファイルのセキュリティ記述子を指定する SECURITY_ATTRIBUTES 構造体へのポインター。lpSecurityAttributes が NULL の場合、ファイルには既定のセキュリティ記述子が設定されます。ファイルの既定のセキュリティ記述子内の ACL は、その親ディレクトリから継承されます。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定したキーとそのすべてのサブキーおよび値を、標準形式で新しいファイルに保存します。(ANSI)

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は Winerror.h で定義されている 0 以外のエラーコードです。 FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグとともに使用すると、エラーの一般的な説明を取得できます。

ファイルが既に存在する場合、この関数は ERROR_ALREADY_EXISTS エラーで失敗します。

解説(Remarks)

hKey がリモートコンピューター上のキーを表す場合、lpFile で指定されるパスはそのリモートコンピューターを基準とした相対パスになります。

RegSaveKey 関数は不揮発性キーのみを保存します。揮発性キーは保存しません。キーが揮発性か不揮発性かは作成時に決まります。 RegCreateKeyEx を参照してください。

RegSaveKey によって作成されたファイルは、その後の RegLoadKey、 RegReplaceKey、または RegRestoreKey 関数の呼び出しで使用できます。RegSaveKey が処理の途中で失敗した場合、ファイルは破損し、そのファイルに対するその後の RegLoadKey、 RegReplaceKey、または RegRestoreKey の呼び出しは失敗します。

レジストリ内のサブツリーをコピーするために RegSaveKey を RegRestoreKey と組み合わせて使用することは推奨されません。この方法は通知をトリガーせず、他のアプリケーションが使用しているハンドルを無効にするおそれがあります。代わりに SHCopyKey 関数または RegCopyTree 関数を使用してください。

呼び出し元プロセスでは SE_BACKUP_NAME 特権が有効になっている必要があります。詳細については、特殊な特権での実行を参照してください。

メモ

winreg.h ヘッダーは RegSaveKey を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

WIN32_ERROR RegSaveKeyA(
    HKEY hKey,
    LPCSTR lpFile,
    const SECURITY_ATTRIBUTES* lpSecurityAttributes   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegSaveKeyA(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string lpFile,   // LPCSTR
    IntPtr lpSecurityAttributes   // SECURITY_ATTRIBUTES* optional
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegSaveKeyA(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> lpFile As String,   ' LPCSTR
    lpSecurityAttributes As IntPtr   ' SECURITY_ATTRIBUTES* optional
) As UInteger
End Function

' hKey : HKEY
' lpFile : LPCSTR
' lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
Declare PtrSafe Function RegSaveKeyA Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal lpFile As String, _
    ByVal lpSecurityAttributes As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegSaveKeyA = ctypes.windll.advapi32.RegSaveKeyA
RegSaveKeyA.restype = wintypes.DWORD
RegSaveKeyA.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPCSTR,  # lpFile : LPCSTR
    ctypes.c_void_p,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegSaveKeyA = Fiddle::Function.new(
  lib['RegSaveKeyA'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    Fiddle::TYPE_VOIDP,  # lpFile : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn RegSaveKeyA(
        hKey: *mut core::ffi::c_void,  // HKEY
        lpFile: *const u8,  // LPCSTR
        lpSecurityAttributes: *const SECURITY_ATTRIBUTES  // SECURITY_ATTRIBUTES* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint RegSaveKeyA(IntPtr hKey, [MarshalAs(UnmanagedType.LPStr)] string lpFile, IntPtr lpSecurityAttributes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegSaveKeyA' -Namespace Win32 -PassThru
# $api::RegSaveKeyA(hKey, lpFile, lpSecurityAttributes)

#uselib "ADVAPI32.dll"
#func global RegSaveKeyA "RegSaveKeyA" sptr, sptr, sptr
; RegSaveKeyA hKey, lpFile, varptr(lpSecurityAttributes)   ; 戻り値は stat
; hKey : HKEY -> "sptr"
; lpFile : LPCSTR -> "sptr"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global RegSaveKeyA "RegSaveKeyA" sptr, str, var
; res = RegSaveKeyA(hKey, lpFile, lpSecurityAttributes)
; hKey : HKEY -> "sptr"
; lpFile : LPCSTR -> "str"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global RegSaveKeyA "RegSaveKeyA" sptr, str, sptr
; res = RegSaveKeyA(hKey, lpFile, varptr(lpSecurityAttributes))
; hKey : HKEY -> "sptr"
; lpFile : LPCSTR -> "str"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。