ホーム › Security.Cryptography.Certificates › CertSrvBackupGetDatabaseNamesW

CertSrvBackupGetDatabaseNamesW

関数

バックアップ対象の証明書サービスデータベース名一覧を取得する。

DLLcertadm.dll呼出規約winapi対応OSwindowsserver2003

シグネチャ

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

HRESULT CertSrvBackupGetDatabaseNamesW(
    void* hbc,
    LPWSTR* ppwszzAttachmentInformation,
    DWORD* pcbSize
);

パラメーター

名前

型

方向

説明

hbc

void*

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

ppwszzAttachmentInformation

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_CERTSERVER_DATABASE	パスを含む、Certificate Services データベースのファイル名。

この割り当てられたメモリは、使用が終わったら CertSrvBackupFree を呼び出して解放する必要があります。この関数を呼び出す前に *ppwszzAttachmentInformation を NULL に設定することは任意です。

pcbSize

DWORD*

out

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

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

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

解説(Remarks)

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

例

FNCERTSRVBACKUPGETDATABASENAMESW* pfnGetDBNames;
char * szGetDBNamesFunc = "CertSrvBackupGetDatabaseNamesW";
WCHAR *    pwszzDBFiles;
DWORD      nListBytes=0;
HRESULT    hr=0;

// Get the address for the desired function.    
// hInst was set by calling LoadLibrary for Certadm.dll.
pfnGetDBNames = (FNCERTSRVBACKUPGETDATABASENAMESW*)
    GetProcAddress(hInst, szGetDBNamesFunc);

if ( NULL == pfnGetDBNames )
{
    printf("Failed GetProcAddress - %s, error=%d\n",
           szGetDBNamesFunc,
           GetLastError() );
    exit(1); // Or other appropriate error action.
}

// Determine the names of the database files.
// hCSBC was set by an earlier call to CertSrvBackupPrepare
hr = pfnGetDBNames(hCSBC, &pwszzDBFiles, &nListBytes);
if (FAILED(hr))
{
    printf("Failed pfnGetDBNames call [%x]\n", hr);
    exit(1); // Or other appropriate error action.
}
else
{
    printf("%d bytes for DB file names\n", nListBytes);
    WCHAR * pwszFile = pwszzDBFiles;
    // Process the list.
    while ( L'\0' != *pwszFile )
    {
        // Use the file name referenced by pwszFile.
        // Here it is merely displayed.
        printf("%02x: %ws\n", *pwszFile, &pwszFile[1]);
        // Move to the next database file name.
        // + 1 moves past the null terminator.
        pwszFile+=(wcslen(pwszFile)) + 1; 
    }
    // Free the allocated memory.
    // pfnBackupFree is the address of the 
    // CertSrvBackupFree function.
    pfnBackupFree(pwszzDBFiles);
}

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

各言語での呼び出し定義

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

HRESULT CertSrvBackupGetDatabaseNamesW(
    void* hbc,
    LPWSTR* ppwszzAttachmentInformation,
    DWORD* pcbSize
);

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

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

' hbc : void*
' ppwszzAttachmentInformation : LPWSTR* out
' pcbSize : DWORD* out
Declare PtrSafe Function CertSrvBackupGetDatabaseNamesW Lib "certadm" ( _
    ByVal hbc As LongPtr, _
    ByVal ppwszzAttachmentInformation 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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "certadm")]
extern "system" {
    fn CertSrvBackupGetDatabaseNamesW(
        hbc: *mut (),  // void*
        ppwszzAttachmentInformation: *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 CertSrvBackupGetDatabaseNamesW(IntPtr hbc, IntPtr ppwszzAttachmentInformation, out uint pcbSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'certadm_CertSrvBackupGetDatabaseNamesW' -Namespace Win32 -PassThru
# $api::CertSrvBackupGetDatabaseNamesW(hbc, ppwszzAttachmentInformation, pcbSize)

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

出力引数:

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