RegSaveKeyExW

関数

形式を指定して指定キーをファイルに保存する。

DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR RegSaveKeyExW(
    HKEY hKey,
    LPCWSTR lpFile,
    const SECURITY_ATTRIBUTES* lpSecurityAttributes,   // optional
    REG_SAVE_FORMAT Flags
);

パラメーター

名前

型

方向

説明

hKey

HKEY

開いているレジストリキーのハンドル。

この関数は HKEY_CLASSES_ROOT 定義済みキーをサポートしません。

lpFile

LPCWSTR

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

新しいファイルにはアーカイブ属性が設定されます。

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

lpSecurityAttributes

SECURITY_ATTRIBUTES*

inoptional

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

Flags

REG_SAVE_FORMAT

保存するキーまたはハイブの形式。このパラメーターには次のいずれかの値を指定できます。

値	意味
REG_STANDARD_FORMAT 1	キーまたはハイブを標準形式で保存します。標準形式は Windows 2000 でサポートされる唯一の形式です。
REG_LATEST_FORMAT 2	キーまたはハイブを最新形式で保存します。最新形式は Windows XP 以降でサポートされます。この形式で保存したキーまたはハイブは、それより前のシステムでは読み込めません。
REG_NO_COMPRESSION 4	ハイブを圧縮せずに保存し、保存処理を高速化します。hKey パラメーターは HKEY_LOCAL_MACHINE または HKEY_USERS 配下のハイブのルートを指定する必要があります。たとえば HKLM\SOFTWARE はハイブのルートです。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定したキーとそのすべてのサブキーおよび値を、指定した形式でレジストリファイルに保存します。(Unicode)

戻り値

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

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

Flags パラメーターに対して上記の値のうち複数が 1 回の呼び出しで指定された場合(たとえば 2 つ以上の値が OR で結合されている場合)、または REG_NO_COMPRESSION が指定され、かつ hKey がハイブのルートではないキーを指定している場合、この関数は ERROR_INVALID_PARAMETER を返します。

解説(Remarks)

RegSaveKey とは異なり、この関数は HKEY_CLASSES_ROOT 定義済みキーをサポートしません。

hKey がリモートコンピューター上のキーを表す場合、lpFile が示すパスはリモートコンピューターからの相対パスになります。

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

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

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

呼び出し元プロセスでは SE_BACKUP_NAME 特権が有効になっている必要があります。詳細は Running with Special Privileges を参照してください。

メモ

winreg.h ヘッダーは RegSaveKeyEx を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細は Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR RegSaveKeyExW(
    HKEY hKey,
    LPCWSTR lpFile,
    const SECURITY_ATTRIBUTES* lpSecurityAttributes,   // optional
    REG_SAVE_FORMAT Flags
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint RegSaveKeyExW(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPWStr)] string lpFile,   // LPCWSTR
    IntPtr lpSecurityAttributes,   // SECURITY_ATTRIBUTES* optional
    uint Flags   // REG_SAVE_FORMAT
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RegSaveKeyExW(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPWStr)> lpFile As String,   ' LPCWSTR
    lpSecurityAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    Flags As UInteger   ' REG_SAVE_FORMAT
) As UInteger
End Function

' hKey : HKEY
' lpFile : LPCWSTR
' lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
' Flags : REG_SAVE_FORMAT
Declare PtrSafe Function RegSaveKeyExW Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal lpFile As LongPtr, _
    ByVal lpSecurityAttributes As LongPtr, _
    ByVal Flags As Long) 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

RegSaveKeyExW = ctypes.windll.advapi32.RegSaveKeyExW
RegSaveKeyExW.restype = wintypes.DWORD
RegSaveKeyExW.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPCWSTR,  # lpFile : LPCWSTR
    ctypes.c_void_p,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
    wintypes.DWORD,  # Flags : REG_SAVE_FORMAT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegSaveKeyExW = Fiddle::Function.new(
  lib['RegSaveKeyExW'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    Fiddle::TYPE_VOIDP,  # lpFile : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
    -Fiddle::TYPE_INT,  # Flags : REG_SAVE_FORMAT
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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