ホーム › Security.Cryptography.Certificates › CertSrvRestorePrepareW
CertSrvRestorePrepareW
関数証明書サービスデータベースの復元を開始準備する。
シグネチャ
// certadm.dll
#include <windows.h>
HRESULT CertSrvRestorePrepareW(
LPCWSTR pwszServerName,
DWORD dwRestoreFlags,
void** phbc
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||
|---|---|---|---|---|---|---|---|
| pwszServerName | LPCWSTR | in | 復元操作の準備を行うサーバーのコンピューター名へのポインター。この名前には NetBIOS 名または DNS 名を指定できます。 | ||||
| dwRestoreFlags | DWORD | in | 次の表に示す値の組み合わせを表すビットフィールドです。
| ||||
| phbc | void** | inout | Certificate Services のバックアップコンテキストハンドル (HCSBC) へのポインター。 |
戻り値の型: HRESULT
公式ドキュメント
Certificate Services インスタンスを復元操作のために準備します。
戻り値
戻り値は HRESULT です。S_OK は成功を示し、*phbc には HCSBC が設定されます。この HCSBC は、他の Certificate Services 復元 API で使用できます。
解説(Remarks)
Certificate Services の復元操作を実行する前に、CertSrvRestorePrepare によって HCSBC を作成しておく必要があります。この HCSBC は、さまざまな Certificate Services 復元関数で使用できます。
メモ 復元セッションが完了したら、CertSrvRestoreEnd を呼び出して、CertSrvRestorePrepare の呼び出しによって得られた HCSBC を解放する必要があります。
この呼び出しを実行するには、復元の特権が必要です。詳細については、 Setting the Backup and Restore Privileges を参照してください。
例
FNCERTSRVRESTOREPREPAREW* pfnRestorePrepare;
char * szRestorePrepFunc = "CertSrvRestorePrepareW";
HCSBC hCSBC=NULL;
HINSTANCE hInst=0;
HRESULT hr=0;
// DLL を読み込みます。
hInst = LoadLibrary(L"Certadm.dll");
if ( NULL == hInst )
{
printf("Failed LoadLibrary,error=%d
",
GetLastError() );
exit(1); // またはその他の適切なエラー処理。
}
// 目的の関数のアドレスを取得します。
pfnRestorePrepare = (FNCERTSRVRESTOREPREPAREW*)GetProcAddress( hInst,
szRestorePrepFunc );
if ( NULL == pfnRestorePrepare )
{
printf("Failed GetProcAddress - %s, error=%d
",
szRestorePrepFunc,
GetLastError() );
exit(1); // またはその他の適切なエラー処理。
}
// CertServ を復元のために準備します。
hr = pfnRestorePrepare(wszServer,
CSRESTORE_TYPE_FULL,
&hCSBC);
if (FAILED(hr))
{
printf("Failed pfnRestorePrepare call [%x]
", hr);
exit(1); // またはその他の適切なエラー処理。
}
// HCSBC を復元操作に使用します。
// ...
// 処理が完了したら、CertSrvRestoreEnd を呼び出して
// HCSBC コンテキストを解放します (ここには示していません)。
// ...
// DLL を解放します。
if (hInst)
FreeLibrary(hInst);
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// certadm.dll
#include <windows.h>
HRESULT CertSrvRestorePrepareW(
LPCWSTR pwszServerName,
DWORD dwRestoreFlags,
void** phbc
);[DllImport("certadm.dll", ExactSpelling = true)]
static extern int CertSrvRestorePrepareW(
[MarshalAs(UnmanagedType.LPWStr)] string pwszServerName, // LPCWSTR
uint dwRestoreFlags, // DWORD
IntPtr phbc // void** in/out
);<DllImport("certadm.dll", ExactSpelling:=True)>
Public Shared Function CertSrvRestorePrepareW(
<MarshalAs(UnmanagedType.LPWStr)> pwszServerName As String, ' LPCWSTR
dwRestoreFlags As UInteger, ' DWORD
phbc As IntPtr ' void** in/out
) As Integer
End Function' pwszServerName : LPCWSTR
' dwRestoreFlags : DWORD
' phbc : void** in/out
Declare PtrSafe Function CertSrvRestorePrepareW Lib "certadm" ( _
ByVal pwszServerName As LongPtr, _
ByVal dwRestoreFlags As Long, _
ByVal phbc As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
CertSrvRestorePrepareW = ctypes.windll.certadm.CertSrvRestorePrepareW
CertSrvRestorePrepareW.restype = ctypes.c_int
CertSrvRestorePrepareW.argtypes = [
wintypes.LPCWSTR, # pwszServerName : LPCWSTR
wintypes.DWORD, # dwRestoreFlags : DWORD
ctypes.c_void_p, # phbc : void** in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('certadm.dll')
CertSrvRestorePrepareW = Fiddle::Function.new(
lib['CertSrvRestorePrepareW'],
[
Fiddle::TYPE_VOIDP, # pwszServerName : LPCWSTR
-Fiddle::TYPE_INT, # dwRestoreFlags : DWORD
Fiddle::TYPE_VOIDP, # phbc : void** in/out
],
Fiddle::TYPE_INT)#[link(name = "certadm")]
extern "system" {
fn CertSrvRestorePrepareW(
pwszServerName: *const u16, // LPCWSTR
dwRestoreFlags: u32, // DWORD
phbc: *mut *mut () // void** in/out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("certadm.dll")]
public static extern int CertSrvRestorePrepareW([MarshalAs(UnmanagedType.LPWStr)] string pwszServerName, uint dwRestoreFlags, IntPtr phbc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'certadm_CertSrvRestorePrepareW' -Namespace Win32 -PassThru
# $api::CertSrvRestorePrepareW(pwszServerName, dwRestoreFlags, phbc)#uselib "certadm.dll"
#func global CertSrvRestorePrepareW "CertSrvRestorePrepareW" sptr, sptr, sptr
; CertSrvRestorePrepareW pwszServerName, dwRestoreFlags, phbc ; 戻り値は stat
; pwszServerName : LPCWSTR -> "sptr"
; dwRestoreFlags : DWORD -> "sptr"
; phbc : void** in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "certadm.dll"
#cfunc global CertSrvRestorePrepareW "CertSrvRestorePrepareW" wstr, int, sptr
; res = CertSrvRestorePrepareW(pwszServerName, dwRestoreFlags, phbc)
; pwszServerName : LPCWSTR -> "wstr"
; dwRestoreFlags : DWORD -> "int"
; phbc : void** in/out -> "sptr"; HRESULT CertSrvRestorePrepareW(LPCWSTR pwszServerName, DWORD dwRestoreFlags, void** phbc)
#uselib "certadm.dll"
#cfunc global CertSrvRestorePrepareW "CertSrvRestorePrepareW" wstr, int, intptr
; res = CertSrvRestorePrepareW(pwszServerName, dwRestoreFlags, phbc)
; pwszServerName : LPCWSTR -> "wstr"
; dwRestoreFlags : DWORD -> "int"
; phbc : void** in/out -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
certadm = windows.NewLazySystemDLL("certadm.dll")
procCertSrvRestorePrepareW = certadm.NewProc("CertSrvRestorePrepareW")
)
// pwszServerName (LPCWSTR), dwRestoreFlags (DWORD), phbc (void** in/out)
r1, _, err := procCertSrvRestorePrepareW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwszServerName))),
uintptr(dwRestoreFlags),
uintptr(phbc),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction CertSrvRestorePrepareW(
pwszServerName: PWideChar; // LPCWSTR
dwRestoreFlags: DWORD; // DWORD
phbc: Pointer // void** in/out
): Integer; stdcall;
external 'certadm.dll' name 'CertSrvRestorePrepareW';result := DllCall("certadm\CertSrvRestorePrepareW"
, "WStr", pwszServerName ; LPCWSTR
, "UInt", dwRestoreFlags ; DWORD
, "Ptr", phbc ; void** in/out
, "Int") ; return: HRESULT●CertSrvRestorePrepareW(pwszServerName, dwRestoreFlags, phbc) = DLL("certadm.dll", "int CertSrvRestorePrepareW(char*, dword, void*)")
# 呼び出し: CertSrvRestorePrepareW(pwszServerName, dwRestoreFlags, phbc)
# pwszServerName : LPCWSTR -> "char*"
# dwRestoreFlags : DWORD -> "dword"
# phbc : void** in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "certadm" fn CertSrvRestorePrepareW(
pwszServerName: [*c]const u16, // LPCWSTR
dwRestoreFlags: u32, // DWORD
phbc: ?*anyopaque // void** in/out
) callconv(std.os.windows.WINAPI) i32;proc CertSrvRestorePrepareW(
pwszServerName: WideCString, # LPCWSTR
dwRestoreFlags: uint32, # DWORD
phbc: pointer # void** in/out
): int32 {.importc: "CertSrvRestorePrepareW", stdcall, dynlib: "certadm.dll".}pragma(lib, "certadm");
extern(Windows)
int CertSrvRestorePrepareW(
const(wchar)* pwszServerName, // LPCWSTR
uint dwRestoreFlags, // DWORD
void** phbc // void** in/out
);ccall((:CertSrvRestorePrepareW, "certadm.dll"), stdcall, Int32,
(Cwstring, UInt32, Ptr{Cvoid}),
pwszServerName, dwRestoreFlags, phbc)
# pwszServerName : LPCWSTR -> Cwstring
# dwRestoreFlags : DWORD -> UInt32
# phbc : void** in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t CertSrvRestorePrepareW(
const uint16_t* pwszServerName,
uint32_t dwRestoreFlags,
void** phbc);
]]
local certadm = ffi.load("certadm")
-- certadm.CertSrvRestorePrepareW(pwszServerName, dwRestoreFlags, phbc)
-- pwszServerName : LPCWSTR
-- dwRestoreFlags : DWORD
-- phbc : void** in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('certadm.dll');
const CertSrvRestorePrepareW = lib.func('__stdcall', 'CertSrvRestorePrepareW', 'int32_t', ['str16', 'uint32_t', 'void *']);
// CertSrvRestorePrepareW(pwszServerName, dwRestoreFlags, phbc)
// pwszServerName : LPCWSTR -> 'str16'
// dwRestoreFlags : DWORD -> 'uint32_t'
// phbc : void** in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("certadm.dll", {
CertSrvRestorePrepareW: { parameters: ["buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.CertSrvRestorePrepareW(pwszServerName, dwRestoreFlags, phbc)
// pwszServerName : LPCWSTR -> "buffer"
// dwRestoreFlags : DWORD -> "u32"
// phbc : void** in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t CertSrvRestorePrepareW(
const uint16_t* pwszServerName,
uint32_t dwRestoreFlags,
void** phbc);
C, "certadm.dll");
// $ffi->CertSrvRestorePrepareW(pwszServerName, dwRestoreFlags, phbc);
// pwszServerName : LPCWSTR
// dwRestoreFlags : DWORD
// phbc : void** in/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 Certadm extends StdCallLibrary {
Certadm INSTANCE = Native.load("certadm", Certadm.class);
int CertSrvRestorePrepareW(
WString pwszServerName, // LPCWSTR
int dwRestoreFlags, // DWORD
Pointer phbc // void** in/out
);
}@[Link("certadm")]
lib Libcertadm
fun CertSrvRestorePrepareW = CertSrvRestorePrepareW(
pwszServerName : UInt16*, # LPCWSTR
dwRestoreFlags : UInt32, # DWORD
phbc : Void** # void** in/out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef CertSrvRestorePrepareWNative = Int32 Function(Pointer<Utf16>, Uint32, Pointer<Void>);
typedef CertSrvRestorePrepareWDart = int Function(Pointer<Utf16>, int, Pointer<Void>);
final CertSrvRestorePrepareW = DynamicLibrary.open('certadm.dll')
.lookupFunction<CertSrvRestorePrepareWNative, CertSrvRestorePrepareWDart>('CertSrvRestorePrepareW');
// pwszServerName : LPCWSTR -> Pointer<Utf16>
// dwRestoreFlags : DWORD -> Uint32
// phbc : void** in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CertSrvRestorePrepareW(
pwszServerName: PWideChar; // LPCWSTR
dwRestoreFlags: DWORD; // DWORD
phbc: Pointer // void** in/out
): Integer; stdcall;
external 'certadm.dll' name 'CertSrvRestorePrepareW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CertSrvRestorePrepareW"
c_CertSrvRestorePrepareW :: CWString -> Word32 -> Ptr () -> IO Int32
-- pwszServerName : LPCWSTR -> CWString
-- dwRestoreFlags : DWORD -> Word32
-- phbc : void** in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let certsrvrestorepreparew =
foreign "CertSrvRestorePrepareW"
((ptr uint16_t) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* pwszServerName : LPCWSTR -> (ptr uint16_t) *)
(* dwRestoreFlags : DWORD -> uint32_t *)
(* phbc : void** in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library certadm (t "certadm.dll"))
(cffi:use-foreign-library certadm)
(cffi:defcfun ("CertSrvRestorePrepareW" cert-srv-restore-prepare-w :convention :stdcall) :int32
(pwsz-server-name (:string :encoding :utf-16le)) ; LPCWSTR
(dw-restore-flags :uint32) ; DWORD
(phbc :pointer)) ; void** in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CertSrvRestorePrepareW = Win32::API::More->new('certadm',
'int CertSrvRestorePrepareW(LPCWSTR pwszServerName, DWORD dwRestoreFlags, LPVOID phbc)');
# my $ret = $CertSrvRestorePrepareW->Call($pwszServerName, $dwRestoreFlags, $phbc);
# pwszServerName : LPCWSTR -> LPCWSTR
# dwRestoreFlags : DWORD -> DWORD
# phbc : void** in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f CertSrvRestoreEnd — 証明書サービスの復元処理を終了する。
- f GetProcAddress — DLLからエクスポート関数のアドレスを取得する。