RegSaveKeyW

関数

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

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

シグネチャ

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

WIN32_ERROR RegSaveKeyW(
    HKEY hKey,
    LPCWSTR lpFile,
    const SECURITY_ATTRIBUTES* lpSecurityAttributes   // optional
);

パラメーター

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

名前

型

方向

説明

hKey

HKEY

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

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

HKEY_CLASSES_ROOT

HKEY_CURRENT_USER

lpFile

LPCWSTR

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

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

lpSecurityAttributes

SECURITY_ATTRIBUTES*

inoptional

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

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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 特権が有効になっている必要があります。詳細については Running with Special Privileges を参照してください。

メモ

winreg.h ヘッダーは RegSaveKey を、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 RegSaveKeyW(
    HKEY hKey,
    LPCWSTR lpFile,
    const SECURITY_ATTRIBUTES* lpSecurityAttributes   // optional
);

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

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

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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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