Win32 API 日本語リファレンス
ホーム › Networking.Clustering › BackupClusterDatabase

BackupClusterDatabase

関数
クラスター構成データベースを指定パスにバックアップする。
DLLCLUSAPI.dll呼出規約winapi対応OSwindowsserver2003

シグネチャ

// CLUSAPI.dll
#include <windows.h>

DWORD BackupClusterDatabase(
    HCLUSTER hCluster,
    LPCWSTR lpszPathName
);

パラメーター

名前型方向説明
hClusterHCLUSTERinバックアップ対象のクラスターへのハンドル。
lpszPathNameLPCWSTRinバックアップの作成先となるパスを指定する、null で終わる Unicode 文字列。クラスターの構成情報がこの場所に保存されます。これは保護すべき機密データです。たとえば、データが格納される場所へのアクセスをアクセス制御リストで制限することにより、このデータを保護できます。

戻り値の型: DWORD

公式ドキュメント

クラスター データベースとすべてのレジストリ チェックポイントのバックアップを作成します。

戻り値

関数が成功すると、ERROR_SUCCESS を返します。

関数が失敗すると、システム エラー コードのいずれかを返します。

解説(Remarks)

指定するパスは、UNC パスのように、すべてのクラスター ノード から参照できるパスであることが理想的です。少なくとも、現在 クォーラム リソース を所有しているノードから参照できる必要があります。パスにファイル名を含めないでください。含めた場合、この関数は失敗し、ERROR_DIRECTORY を返します。パスの末尾に円記号 (バックスラッシュ) を付けることはできます。

適切なパスを確実に用意する方法の 1 つは、次の手順で一時的なネットワーク共有を作成することです。

バックアップには次のファイルが含まれます。
パス\ファイル 説明
lpszPathName\chk????.tmp スナップショット ファイル。
lpszPathName\quolog.log クォーラム ログ ファイル。
lpszPathName\<GUID of resource>\*.CPT GUID で識別されるリソースのレジストリ チェックポイント ファイル。
lpszPathName\<GUID of resource>\*.CPR GUID で識別されるリソースの暗号化チェックポイント ファイル。
lpszPathName\Clusbackup.dat バックアップ完了を示すマーカー ファイル (読み取り専用、隠し属性、0 バイトのファイル)

同じ lpszPath パラメーターを使用して BackupClusterDatabase を再度実行すると、既存のバックアップ ファイルは上書きされます。

可能であれば、バックアップ ディレクトリのコピーを複数のメディアに作成し、それぞれ別の場所に保管してください。

例

次の例は、静的なバックアップ ルーチンを示しています。RestoreClusterDatabase を組み込んだ、より完全な例については、クラスター構成のバックアップと復元を参照してください。この例では、フェールオーバー クラスターのドキュメントで定義されている ClusDocEx.h ヘッダー ファイルを使用します。


int main( void )
 {
  HCLUSTER hCluster     = NULL;
  WCHAR szClusterName[] = L"CLUSTER_NAME";
  WCHAR szPath[]        = L"\\\\ClusBack\\19991215";
  DWORD dwResult        = ERROR_SUCCESS;
 
  if( ( hCluster = OpenCluster( szClusterName ) ) != NULL )
   {
    dwResult = BackupClusterDatabase( hCluster, szPath );
    CloseCluster( hCluster );
   }
  else
    dwResult = GetLastError();

  if( dwResult == ERROR_SUCCESS )
   {
    wprintf( L"\nDone. The cluster database has been backed up to %s. ", szPath );
    wprintf( L"The backup consists of the following files:\n    chk????.tmp\n"
             L"    quolog.log\n    *.cpt\n    *.cpr\n\n" );
    return 0;
   }
  else
   {
    wprintf( L"The operation failed (%d)\n", dwResult );
    return 1;
   }
 }
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// CLUSAPI.dll
#include <windows.h>

DWORD BackupClusterDatabase(
    HCLUSTER hCluster,
    LPCWSTR lpszPathName
);
[DllImport("CLUSAPI.dll", ExactSpelling = true)]
static extern uint BackupClusterDatabase(
    IntPtr hCluster,   // HCLUSTER
    [MarshalAs(UnmanagedType.LPWStr)] string lpszPathName   // LPCWSTR
);
<DllImport("CLUSAPI.dll", ExactSpelling:=True)>
Public Shared Function BackupClusterDatabase(
    hCluster As IntPtr,   ' HCLUSTER
    <MarshalAs(UnmanagedType.LPWStr)> lpszPathName As String   ' LPCWSTR
) As UInteger
End Function
' hCluster : HCLUSTER
' lpszPathName : LPCWSTR
Declare PtrSafe Function BackupClusterDatabase Lib "clusapi" ( _
    ByVal hCluster As LongPtr, _
    ByVal lpszPathName As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BackupClusterDatabase = ctypes.windll.clusapi.BackupClusterDatabase
BackupClusterDatabase.restype = wintypes.DWORD
BackupClusterDatabase.argtypes = [
    ctypes.c_ssize_t,  # hCluster : HCLUSTER
    wintypes.LPCWSTR,  # lpszPathName : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CLUSAPI.dll')
BackupClusterDatabase = Fiddle::Function.new(
  lib['BackupClusterDatabase'],
  [
    Fiddle::TYPE_INTPTR_T,  # hCluster : HCLUSTER
    Fiddle::TYPE_VOIDP,  # lpszPathName : LPCWSTR
  ],
  -Fiddle::TYPE_INT)
#[link(name = "clusapi")]
extern "system" {
    fn BackupClusterDatabase(
        hCluster: isize,  // HCLUSTER
        lpszPathName: *const u16  // LPCWSTR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("CLUSAPI.dll")]
public static extern uint BackupClusterDatabase(IntPtr hCluster, [MarshalAs(UnmanagedType.LPWStr)] string lpszPathName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CLUSAPI_BackupClusterDatabase' -Namespace Win32 -PassThru
# $api::BackupClusterDatabase(hCluster, lpszPathName)
#uselib "CLUSAPI.dll"
#func global BackupClusterDatabase "BackupClusterDatabase" sptr, sptr
; BackupClusterDatabase hCluster, lpszPathName   ; 戻り値は stat
; hCluster : HCLUSTER -> "sptr"
; lpszPathName : LPCWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "CLUSAPI.dll"
#cfunc global BackupClusterDatabase "BackupClusterDatabase" sptr, wstr
; res = BackupClusterDatabase(hCluster, lpszPathName)
; hCluster : HCLUSTER -> "sptr"
; lpszPathName : LPCWSTR -> "wstr"
; DWORD BackupClusterDatabase(HCLUSTER hCluster, LPCWSTR lpszPathName)
#uselib "CLUSAPI.dll"
#cfunc global BackupClusterDatabase "BackupClusterDatabase" intptr, wstr
; res = BackupClusterDatabase(hCluster, lpszPathName)
; hCluster : HCLUSTER -> "intptr"
; lpszPathName : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	clusapi = windows.NewLazySystemDLL("CLUSAPI.dll")
	procBackupClusterDatabase = clusapi.NewProc("BackupClusterDatabase")
)

// hCluster (HCLUSTER), lpszPathName (LPCWSTR)
r1, _, err := procBackupClusterDatabase.Call(
	uintptr(hCluster),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszPathName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function BackupClusterDatabase(
  hCluster: NativeInt;   // HCLUSTER
  lpszPathName: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'CLUSAPI.dll' name 'BackupClusterDatabase';
result := DllCall("CLUSAPI\BackupClusterDatabase"
    , "Ptr", hCluster   ; HCLUSTER
    , "WStr", lpszPathName   ; LPCWSTR
    , "UInt")   ; return: DWORD
●BackupClusterDatabase(hCluster, lpszPathName) = DLL("CLUSAPI.dll", "dword BackupClusterDatabase(int, char*)")
# 呼び出し: BackupClusterDatabase(hCluster, lpszPathName)
# hCluster : HCLUSTER -> "int"
# lpszPathName : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "clusapi" fn BackupClusterDatabase(
    hCluster: isize, // HCLUSTER
    lpszPathName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) u32;
proc BackupClusterDatabase(
    hCluster: int,  # HCLUSTER
    lpszPathName: WideCString  # LPCWSTR
): uint32 {.importc: "BackupClusterDatabase", stdcall, dynlib: "CLUSAPI.dll".}
pragma(lib, "clusapi");
extern(Windows)
uint BackupClusterDatabase(
    ptrdiff_t hCluster,   // HCLUSTER
    const(wchar)* lpszPathName   // LPCWSTR
);
ccall((:BackupClusterDatabase, "CLUSAPI.dll"), stdcall, UInt32,
      (Int, Cwstring),
      hCluster, lpszPathName)
# hCluster : HCLUSTER -> Int
# lpszPathName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t BackupClusterDatabase(
    intptr_t hCluster,
    const uint16_t* lpszPathName);
]]
local clusapi = ffi.load("clusapi")
-- clusapi.BackupClusterDatabase(hCluster, lpszPathName)
-- hCluster : HCLUSTER
-- lpszPathName : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('CLUSAPI.dll');
const BackupClusterDatabase = lib.func('__stdcall', 'BackupClusterDatabase', 'uint32_t', ['intptr_t', 'str16']);
// BackupClusterDatabase(hCluster, lpszPathName)
// hCluster : HCLUSTER -> 'intptr_t'
// lpszPathName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("CLUSAPI.dll", {
  BackupClusterDatabase: { parameters: ["isize", "buffer"], result: "u32" },
});
// lib.symbols.BackupClusterDatabase(hCluster, lpszPathName)
// hCluster : HCLUSTER -> "isize"
// lpszPathName : LPCWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t BackupClusterDatabase(
    intptr_t hCluster,
    const uint16_t* lpszPathName);
C, "CLUSAPI.dll");
// $ffi->BackupClusterDatabase(hCluster, lpszPathName);
// hCluster : HCLUSTER
// lpszPathName : LPCWSTR
// 構造体/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 Clusapi extends StdCallLibrary {
    Clusapi INSTANCE = Native.load("clusapi", Clusapi.class);
    int BackupClusterDatabase(
        long hCluster,   // HCLUSTER
        WString lpszPathName   // LPCWSTR
    );
}
@[Link("clusapi")]
lib LibCLUSAPI
  fun BackupClusterDatabase = BackupClusterDatabase(
    hCluster : LibC::SSizeT,   # HCLUSTER
    lpszPathName : UInt16*   # LPCWSTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef BackupClusterDatabaseNative = Uint32 Function(IntPtr, Pointer<Utf16>);
typedef BackupClusterDatabaseDart = int Function(int, Pointer<Utf16>);
final BackupClusterDatabase = DynamicLibrary.open('CLUSAPI.dll')
    .lookupFunction<BackupClusterDatabaseNative, BackupClusterDatabaseDart>('BackupClusterDatabase');
// hCluster : HCLUSTER -> IntPtr
// lpszPathName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BackupClusterDatabase(
  hCluster: NativeInt;   // HCLUSTER
  lpszPathName: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'CLUSAPI.dll' name 'BackupClusterDatabase';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BackupClusterDatabase"
  c_BackupClusterDatabase :: CIntPtr -> CWString -> IO Word32
-- hCluster : HCLUSTER -> CIntPtr
-- lpszPathName : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let backupclusterdatabase =
  foreign "BackupClusterDatabase"
    (intptr_t @-> (ptr uint16_t) @-> returning uint32_t)
(* hCluster : HCLUSTER -> intptr_t *)
(* lpszPathName : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library clusapi (t "CLUSAPI.dll"))
(cffi:use-foreign-library clusapi)

(cffi:defcfun ("BackupClusterDatabase" backup-cluster-database :convention :stdcall) :uint32
  (h-cluster :int64)   ; HCLUSTER
  (lpsz-path-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BackupClusterDatabase = Win32::API::More->new('CLUSAPI',
    'DWORD BackupClusterDatabase(LPARAM hCluster, LPCWSTR lpszPathName)');
# my $ret = $BackupClusterDatabase->Call($hCluster, $lpszPathName);
# hCluster : HCLUSTER -> LPARAM
# lpszPathName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目