ホーム › Security.Cryptography.Certificates › CertSrvBackupGetBackupLogsW

CertSrvBackupGetBackupLogsW

関数

証明書サービスのバックアップ対象ログファイル一覧を取得する。

DLLcertadm.dll呼出規約winapi対応OSwindowsserver2003

シグネチャ

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

HRESULT CertSrvBackupGetBackupLogsW(
    void* hbc,
    LPWSTR* ppwszzBackupLogFiles,
    DWORD* pcbSize
);

パラメーター

名前

型

方向

説明

hbc

void*

Certificate Services バックアップコンテキストへのハンドル。

ppwszzBackupLogFiles

LPWSTR*

out

null で終わるログファイル名の一覧を受け取る WCHAR ポインターへのポインター。各ファイル名の後には null 文字が 1 つ付き、一覧の末尾にはさらにもう 1 つの null 文字が付きます。ファイル名は UNC 形式 "## \\Server\SharePoint\…Path…\FileName.ext" になります。ディレクトリ名も同じ形式ですが、末尾の "\FileName.ext" は付きません。"##" は Certificate Services のバックアップファイルの種類 (CSBFT_*) を表し、各 UNC パスの先頭に付加された null 以外の 1 文字の Unicode 文字として格納されます。この種類のタグは Certbcli.h で定義されており、この関数では次のいずれかの値になります。

値	意味
CSBFT_LOG	パスを含む、Certificate Services データベースのログファイル名。
CSBFT_PATCH_FILE	Certificate Services データベースの更新ファイルの、パスを含む名前。 Windows Server 2003: データベースの更新ファイルは使用されません。

この割り当てられたメモリの使用が終わったら、CertSrvBackupFree 関数を呼び出して解放します。

この関数を呼び出す前に ppwszzBackupLogFiles を NULL に設定することは任意です。

pcbSize

DWORD*

out

ppwszzBackupLogFiles のバイト数を指定する DWORD 値へのポインター。

戻り値の型: HRESULT

公式ドキュメント

指定されたバックアップコンテキストについて、バックアップが必要な Certificate Services のログファイル名の一覧を取得します。

戻り値

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

解説(Remarks)

ログファイルには、最後にログファイルを切り詰めてから発生したデータベースの処理 (要求の送信、証明書の失効など) が記録されます。データベースの処理が行われるにつれて、ログファイルの量は増加します。バックアップを実行した後に CertSrvBackupTruncateLogs を呼び出すと、ログファイルのサイズを縮小できます。

Certadm.dll におけるこの関数の名前は CertSrvBackupGetBackupLogsW です。GetProcAddress を呼び出すときは、この形式の名前を使用する必要があります。また、この関数は Certbcli.h ヘッダーファイルで FNCERTSRVBACKUPGETBACKUPLOGSW 型として定義されています。

例

FNCERTSRVBACKUPGETBACKUPLOGSW* pfnGetBackupLogs;
char * szGetBackupLogsFunc = "CertSrvBackupGetBackupLogsW";

WCHAR *    pwszzLogFiles;

DWORD      nListBytes=0;

HRESULT    hr=0;

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

// ログファイルの名前を調べます。
// hCSBC は事前の CertSrvbackupPrepare の呼び出しで設定済みです。
hr = pfnGetBackupLogs(hCSBC, &pwszzLogFiles, &nListBytes);
if (FAILED(hr))
{
    printf("Failed pfnGetBackupLogs call [%x]\n", hr);
    exit(1); // または他の適切なエラー処理。
}
else
{
    printf("%d bytes for log file names\n", nListBytes);
    WCHAR * pwszLog = pwszzLogFiles;
    // 一覧を処理します。
    while ( L'\0' != *pwszLog )
    {
        // pwszLog が参照するファイル名を使用します。
        // ここでは単に表示しているだけです。
        printf("%02x: %ws\n", *pwszLog, &pwszLog[1]);
        // 次のログファイル名へ移動します。
        // + 1 で null 終端文字を読み飛ばします。
        pwszLog+=(wcslen(pwszLog)) + 1; 
    }

    // 割り当てられたメモリを解放します。
    // pfnBackupFree は CertSrvBackupFree 関数の
       // アドレスです。
    pfnBackupFree(pwszzLogFiles);
}

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

各言語での呼び出し定義

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

HRESULT CertSrvBackupGetBackupLogsW(
    void* hbc,
    LPWSTR* ppwszzBackupLogFiles,
    DWORD* pcbSize
);

[DllImport("certadm.dll", ExactSpelling = true)]
static extern int CertSrvBackupGetBackupLogsW(
    IntPtr hbc,   // void*
    IntPtr ppwszzBackupLogFiles,   // LPWSTR* out
    out uint pcbSize   // DWORD* out
);

<DllImport("certadm.dll", ExactSpelling:=True)>
Public Shared Function CertSrvBackupGetBackupLogsW(
    hbc As IntPtr,   ' void*
    ppwszzBackupLogFiles As IntPtr,   ' LPWSTR* out
    <Out> ByRef pcbSize As UInteger   ' DWORD* out
) As Integer
End Function

' hbc : void*
' ppwszzBackupLogFiles : LPWSTR* out
' pcbSize : DWORD* out
Declare PtrSafe Function CertSrvBackupGetBackupLogsW Lib "certadm" ( _
    ByVal hbc As LongPtr, _
    ByVal ppwszzBackupLogFiles As LongPtr, _
    ByRef pcbSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertSrvBackupGetBackupLogsW = ctypes.windll.certadm.CertSrvBackupGetBackupLogsW
CertSrvBackupGetBackupLogsW.restype = ctypes.c_int
CertSrvBackupGetBackupLogsW.argtypes = [
    ctypes.POINTER(None),  # hbc : void*
    ctypes.c_void_p,  # ppwszzBackupLogFiles : LPWSTR* out
    ctypes.POINTER(wintypes.DWORD),  # pcbSize : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('certadm.dll')
CertSrvBackupGetBackupLogsW = Fiddle::Function.new(
  lib['CertSrvBackupGetBackupLogsW'],
  [
    Fiddle::TYPE_VOIDP,  # hbc : void*
    Fiddle::TYPE_VOIDP,  # ppwszzBackupLogFiles : LPWSTR* out
    Fiddle::TYPE_VOIDP,  # pcbSize : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "certadm")]
extern "system" {
    fn CertSrvBackupGetBackupLogsW(
        hbc: *mut (),  // void*
        ppwszzBackupLogFiles: *mut *mut u16,  // LPWSTR* out
        pcbSize: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("certadm.dll")]
public static extern int CertSrvBackupGetBackupLogsW(IntPtr hbc, IntPtr ppwszzBackupLogFiles, out uint pcbSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'certadm_CertSrvBackupGetBackupLogsW' -Namespace Win32 -PassThru
# $api::CertSrvBackupGetBackupLogsW(hbc, ppwszzBackupLogFiles, pcbSize)

#uselib "certadm.dll"
#func global CertSrvBackupGetBackupLogsW "CertSrvBackupGetBackupLogsW" sptr, sptr, sptr
; CertSrvBackupGetBackupLogsW hbc, varptr(ppwszzBackupLogFiles), varptr(pcbSize)   ; 戻り値は stat
; hbc : void* -> "sptr"
; ppwszzBackupLogFiles : LPWSTR* out -> "sptr"
; pcbSize : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "certadm.dll"
#cfunc global CertSrvBackupGetBackupLogsW "CertSrvBackupGetBackupLogsW" sptr, var, var
; res = CertSrvBackupGetBackupLogsW(hbc, ppwszzBackupLogFiles, pcbSize)
; hbc : void* -> "sptr"
; ppwszzBackupLogFiles : LPWSTR* out -> "var"
; pcbSize : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "certadm.dll"
#cfunc global CertSrvBackupGetBackupLogsW "CertSrvBackupGetBackupLogsW" sptr, sptr, sptr
; res = CertSrvBackupGetBackupLogsW(hbc, varptr(ppwszzBackupLogFiles), varptr(pcbSize))
; hbc : void* -> "sptr"
; ppwszzBackupLogFiles : LPWSTR* out -> "sptr"
; pcbSize : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。