Win32 API 日本語リファレンス
ホーム › Security.Cryptography.Certificates › CertSrvBackupTruncateLogs

CertSrvBackupTruncateLogs

関数
バックアップ済みの証明書サービスログファイルを切り詰める。
DLLcertadm.dll呼出規約winapi対応OSwindowsserver2003

シグネチャ

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

HRESULT CertSrvBackupTruncateLogs(
    void* hbc
);

パラメーター

名前型方向説明
hbcvoid*inoutCertificate Services のバックアップコンテキストへのハンドル。

戻り値の型: HRESULT

公式ドキュメント

冗長なレコードを削除し、ログファイルが使用するディスクの記憶領域を削減します。

戻り値

戻り値は HRESULT です。S_OK は成功を示します。

解説(Remarks)

データベースとログファイルのバックアップを確保した後、必要に応じてログファイルを切り詰める (truncate) ことができます。ログファイルの容量はデータベースの動作に伴って増加しますが、ログファイルを切り詰めると、ログファイル内の冗長なレコードが削減されます (その結果、ログファイルの格納に使用されるディスク領域が減少します)。

ログファイルは、データベースの整合性と効率のために用意されています。Certificate Services アプリケーションが正常に終了しなかった場合、次に Certificate Services が開始されたときに、データベースはログファイルを再生 (replay) し、データベースにデータの破損が持ち込まれるのを防ぎます。

ログファイルの容量によっては、ログファイルの再生に時間がかかることがあります。この再生の間、証明機関は他の処理を行えません。なお、Certificate Services アプリケーションが適切に停止された場合 (サービスを停止した場合や、オペレーティングシステムを正しくシャットダウンした場合など) は、次回の開始時にログファイルは再生されません。

注意 CertSrvBackupGetDatabaseNames および CertSrvBackupGetBackupLogs から返されたすべてのファイルをバックアップせずに CertSrvBackupTruncateLogs を呼び出すと、バックアップセットを正常に復元できなくなり、Certificate Services のコンピューターが使用できなくなります。そのため、CertSrvBackupTruncateLogs は、バックアップセットに CertSrvBackupGetDatabaseNames と CertSrvBackupGetBackupLogs から返されたすべてのファイルが含まれている場合にのみ呼び出してください。

例

FNCERTSRVBACKUPTRUNCATELOGS* pfnTruncateLogs;
char * szTruncateLogsFunc = "CertSrvBackupTruncateLogs";

HRESULT    hr=0;

// 目的の関数のアドレスを取得する。
// hInst は Certadm.dll に対して LoadLibrary を呼び出して設定済み。
pfnTruncateLogs = (FNCERTSRVBACKUPTRUNCATELOGS*)GetProcAddress( hInst,
                                           szTruncateLogsFunc );
if ( NULL == pfnTruncateLogs )
{
    printf("Failed GetProcAddress - %s, error=%d\n",
           szTruncateLogsFunc,
           GetLastError() );
    exit(1); // または他の適切なエラー処理。
}

// バックアップが完了した後で、ログを切り詰める。
// hCSBC は事前に設定済みの HCSBC 変数。
hr = pfnTruncateLogs(hCSBC);
if (FAILED(hr))
{
    printf("Failed pfnTruncateLogs call [%x]\n", hr);
    exit(1); // または他の適切なエラー処理。
}
else
    printf("Logs truncated\n");
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT CertSrvBackupTruncateLogs(
    void* hbc
);
[DllImport("certadm.dll", ExactSpelling = true)]
static extern int CertSrvBackupTruncateLogs(
    IntPtr hbc   // void* in/out
);
<DllImport("certadm.dll", ExactSpelling:=True)>
Public Shared Function CertSrvBackupTruncateLogs(
    hbc As IntPtr   ' void* in/out
) As Integer
End Function
' hbc : void* in/out
Declare PtrSafe Function CertSrvBackupTruncateLogs Lib "certadm" ( _
    ByVal hbc As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CertSrvBackupTruncateLogs = ctypes.windll.certadm.CertSrvBackupTruncateLogs
CertSrvBackupTruncateLogs.restype = ctypes.c_int
CertSrvBackupTruncateLogs.argtypes = [
    ctypes.POINTER(None),  # hbc : void* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('certadm.dll')
CertSrvBackupTruncateLogs = Fiddle::Function.new(
  lib['CertSrvBackupTruncateLogs'],
  [
    Fiddle::TYPE_VOIDP,  # hbc : void* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "certadm")]
extern "system" {
    fn CertSrvBackupTruncateLogs(
        hbc: *mut ()  // void* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("certadm.dll")]
public static extern int CertSrvBackupTruncateLogs(IntPtr hbc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'certadm_CertSrvBackupTruncateLogs' -Namespace Win32 -PassThru
# $api::CertSrvBackupTruncateLogs(hbc)
#uselib "certadm.dll"
#func global CertSrvBackupTruncateLogs "CertSrvBackupTruncateLogs" sptr
; CertSrvBackupTruncateLogs hbc   ; 戻り値は stat
; hbc : void* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "certadm.dll"
#cfunc global CertSrvBackupTruncateLogs "CertSrvBackupTruncateLogs" sptr
; res = CertSrvBackupTruncateLogs(hbc)
; hbc : void* in/out -> "sptr"
; HRESULT CertSrvBackupTruncateLogs(void* hbc)
#uselib "certadm.dll"
#cfunc global CertSrvBackupTruncateLogs "CertSrvBackupTruncateLogs" intptr
; res = CertSrvBackupTruncateLogs(hbc)
; hbc : void* in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	certadm = windows.NewLazySystemDLL("certadm.dll")
	procCertSrvBackupTruncateLogs = certadm.NewProc("CertSrvBackupTruncateLogs")
)

// hbc (void* in/out)
r1, _, err := procCertSrvBackupTruncateLogs.Call(
	uintptr(hbc),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function CertSrvBackupTruncateLogs(
  hbc: Pointer   // void* in/out
): Integer; stdcall;
  external 'certadm.dll' name 'CertSrvBackupTruncateLogs';
result := DllCall("certadm\CertSrvBackupTruncateLogs"
    , "Ptr", hbc   ; void* in/out
    , "Int")   ; return: HRESULT
●CertSrvBackupTruncateLogs(hbc) = DLL("certadm.dll", "int CertSrvBackupTruncateLogs(void*)")
# 呼び出し: CertSrvBackupTruncateLogs(hbc)
# hbc : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "certadm" fn CertSrvBackupTruncateLogs(
    hbc: ?*anyopaque // void* in/out
) callconv(std.os.windows.WINAPI) i32;
proc CertSrvBackupTruncateLogs(
    hbc: pointer  # void* in/out
): int32 {.importc: "CertSrvBackupTruncateLogs", stdcall, dynlib: "certadm.dll".}
pragma(lib, "certadm");
extern(Windows)
int CertSrvBackupTruncateLogs(
    void* hbc   // void* in/out
);
ccall((:CertSrvBackupTruncateLogs, "certadm.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      hbc)
# hbc : void* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CertSrvBackupTruncateLogs(
    void* hbc);
]]
local certadm = ffi.load("certadm")
-- certadm.CertSrvBackupTruncateLogs(hbc)
-- hbc : void* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('certadm.dll');
const CertSrvBackupTruncateLogs = lib.func('__stdcall', 'CertSrvBackupTruncateLogs', 'int32_t', ['void *']);
// CertSrvBackupTruncateLogs(hbc)
// hbc : void* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("certadm.dll", {
  CertSrvBackupTruncateLogs: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.CertSrvBackupTruncateLogs(hbc)
// hbc : void* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CertSrvBackupTruncateLogs(
    void* hbc);
C, "certadm.dll");
// $ffi->CertSrvBackupTruncateLogs(hbc);
// hbc : 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 CertSrvBackupTruncateLogs(
        Pointer hbc   // void* in/out
    );
}
@[Link("certadm")]
lib Libcertadm
  fun CertSrvBackupTruncateLogs = CertSrvBackupTruncateLogs(
    hbc : 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 CertSrvBackupTruncateLogsNative = Int32 Function(Pointer<Void>);
typedef CertSrvBackupTruncateLogsDart = int Function(Pointer<Void>);
final CertSrvBackupTruncateLogs = DynamicLibrary.open('certadm.dll')
    .lookupFunction<CertSrvBackupTruncateLogsNative, CertSrvBackupTruncateLogsDart>('CertSrvBackupTruncateLogs');
// hbc : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CertSrvBackupTruncateLogs(
  hbc: Pointer   // void* in/out
): Integer; stdcall;
  external 'certadm.dll' name 'CertSrvBackupTruncateLogs';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CertSrvBackupTruncateLogs"
  c_CertSrvBackupTruncateLogs :: Ptr () -> IO Int32
-- hbc : void* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let certsrvbackuptruncatelogs =
  foreign "CertSrvBackupTruncateLogs"
    ((ptr void) @-> returning int32_t)
(* hbc : 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 ("CertSrvBackupTruncateLogs" cert-srv-backup-truncate-logs :convention :stdcall) :int32
  (hbc :pointer))   ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CertSrvBackupTruncateLogs = Win32::API::More->new('certadm',
    'int CertSrvBackupTruncateLogs(LPVOID hbc)');
# my $ret = $CertSrvBackupTruncateLogs->Call($hbc);
# hbc : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目