CertSrvBackupPrepareW 関数 (certbcli.h)

  • [アーティクル]

CertSrvBackupPrepare 関数は、バックアップ操作用に証明書サービス サーバーを準備するために使用されます。

構文

HRESULT CERTBCLI_API CertSrvBackupPrepareW(
  [in]  WCHAR const *pwszServerName,
  [in]  ULONG       grbitJet,
  [in]  ULONG       dwBackupFlags,
  [out] HCSBC       *phbc
);

パラメーター

[in] pwszServerName

オンライン バックアップの準備を行うサーバーのコンピューター名へのポインター。 この名前には、NetBIOS 名または DNS 名を指定できます。

[in] grbitJet

データベース エンジンによって使用される値。この値は 0 に設定する必要があります。

[in] dwBackupFlags

バックアップの種類を指定します。 次のいずれかの値を指定できます。

値 意味
CSBACKUP_TYPE_FULL
 Certificate Services データベース、ログ、および関連ファイルをバックアップします。
CSBACKUP_TYPE_LOGS_ONLY
 ログ ファイルのみをバックアップします。

[out] phbc

Certificate Services バックアップ コンテキスト ハンドル (HCSBC) へのポインター。

戻り値

戻り値は HRESULT です。 S_OK の値は成功を示し、*phbc は他の Certificate Services バックアップ API で使用できる HCSBC に設定されます。

注釈

証明書サービスのバックアップを行う前に、CertSrvBackupPrepare を使用して HCSBC を作成する必要があります。 結果の HCSBC は、Certificate Services バックアップ機能の必要なパラメーターであり、ファイルの一覧表示、開き、読み取り、閉じ、ログ ファイルの切り捨てに使用できます。

メモバックアップ セッションが完了したら、CertSrvBackupEnd を呼び出して、CertSrvBackupPrepare の呼び出しの結果として発生した HCSBC を解放する必要があります。
 
Certadm.dll のこの関数の名前は CertSrvBackupPrepareW です。 GetProcAddress を呼び出すときは、この形式の名前を使用する必要があります。 また、この関数は Certbcli.h ヘッダー ファイルで FNCERTSRVBACKUPPREPAREW 型として定義されます。

この呼び出しを実行するには、バックアップ 特権が必要です。 詳細については、「 バックアップと復元の特権の設定」を参照してください。

例

WCHAR *    wszServer = L"MyCertServerMachine";
FNCERTSRVBACKUPPREPAREW* pfnBackupPrepare;
char * szBackPrepFunc = "CertSrvBackupPrepareW";
HINSTANCE  hInst=0;
HCSBC      hCSBC=NULL;
HRESULT    hr=0;

// Load the DLL.
hInst = LoadLibrary(L"Certadm.dll");
if ( NULL == hInst )
{
    printf("Failed LoadLibrary, error=%d\n",
            GetLastError() );
    exit(1); // Or other appropriate error action.
}
// Get the address for the desired function.
pfnBackupPrepare = (FNCERTSRVBACKUPPREPAREW*)GetProcAddress( hInst,
                                        szBackPrepFunc );
if ( NULL == pfnBackupPrepare )
{
    printf("Failed GetProcAddress - %s, error=%d\n",
           szBackPrepFunc,
           GetLastError() );
    exit(1); // Or other appropriate error action.
}

// Prepare CertServ for backup.
hr = pfnBackupPrepare(wszServer,
                      0,
                      CSBACKUP_TYPE_FULL,
                      &hCSBC);
if (FAILED(hr))
{
    printf("Failed pfnBackupPrepare call [%x]\n", hr);
    exit(1); // Or other appropriate error action.
}

// Use the HCSBC for backup operations.
// ...

// When done processing, release the HCSBC context
// by calling CertSrvBackupEnd (not shown here).
// ...


// Done processing, free the DLL.
if (hInst)
    FreeLibrary(hInst);

要件

要件 値
サポートされている最小のクライアント サポートなし
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー certbcli.h (Certsrv.h を含む)
Library Certadm.lib
[DLL] Certadm.dll

こちらもご覧ください

CertSrvBackupEnd

証明書サービスのバックアップと復元の機能の使用