CertSrvBackupOpenFileW 関数 (certbcli.h)

CertSrvBackupOpenFile 関数は、バックアップ用のファイルを開きます。

構文

HRESULT CERTBCLI_API CertSrvBackupOpenFileW(
  [in]  HCSBC         hbc,
  [in]  WCHAR const   *pwszAttachmentName,
  [in]  DWORD         cbReadHintSize,
  [out] LARGE_INTEGER *pliFileSize
);

パラメーター

[in] hbc

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

[in] pwszAttachmentName

バックアップ目的で開くファイル名。 このファイル名は、 CertSrvBackupGetBackupLogs または CertSrvBackupGetDatabaseNames によって生成されたリストから解析されます。 CertSrvBackupGetBackupLogs および CertSrvBackupGetDatabaseNames によって返される名前には、CertSrvBackupOpenFile が呼び出される前に、単一 WCHAR CSBFT_* プレフィックスが削除されている必要があります。

[in] cbReadHintSize

ファイルが CertSrvBackupRead によって読み取られたときにヒントとして使用されるバイト数。 バックアップ コンテキストの最初の CertSrvBackupOpenFile 呼び出しに渡される cbReadHintSize パラメーターは、読み取りバッファーのサイズを設定するために使用されます。 このパラメーターには 0 を渡します。バッファーのサイズは、 CertSrvBackupOpenFile によって選択された合理的に効率的なサイズになります。 十分なメモリが使用できない場合、メモリ割り当てが成功するまで、またはバッファー サイズが可能な最小値に達するまで、バッファー サイズが小さくなります。 CertSrvBackupOpenFile が cbReadHintSize の値に近い 2 の累乗にバッファーのサイズを設定するには、0 以外のサイズを渡します。 実装では、64 KB から 4 MB の 2 つの累乗のみを選択します。

[out] pliFileSize

ファイル内のバイト数を表す LARGE_INTEGER 値へのポインター。

戻り値

関数が成功した場合、関数はS_OKを返します。

関数が失敗した場合は、エラーを示す HRESULT 値を返します。 一般的なエラー コードの一覧については、「 共通の HRESULT 値」を参照してください。

注釈

バックアップ目的でファイルを開くには、この関数を使用します。 ファイルの使用が完了したら、 CertSrvBackupClose 関数を呼び出してファイルを閉じます。

Certadm.dll のこの関数の名前は CertSrvBackupOpenFileW です。 GetProcAddress を呼び出すときは、この形式の名前を使用する必要があります。 また、この関数は Certbcli.h で FNCERTSRVBACKUPOPENFILEW 型として定義されます。

例

FNCERTSRVBACKUPOPENFILEW* pfnOpenFile;
char * szBackupOpenFunc = "CertSrvBackupOpenFileW";
LARGE_INTEGER liFileSize;
HRESULT       hr=0;

// Get the address for the desired function.    
// hInst was set by calling LoadLibrary for Certadm.dll.
pfnOpenFile = (FNCERTSRVBACKUPOPENFILEW*)GetProcAddress(hInst,
                                         szBackupOpenFunc);
if ( NULL == pfnOpenFile )
{
    printf("Failed GetProcAddress - %s, error=%d\n",
            szBackupOpenFunc,
            GetLastError() );
    exit(1); // or other appropriate error action
}

// Open the file.
// hCSBC was set by an earlier call to CertSrvBackupPrepare.
// pwszFile specifies the name of a file.
// This name could have resulted from parsing the
// output from CertSrvBackupGetDatabaseNames, and so on.
hr = pfnOpenFile(hCSBC,
                pwszFile,
                0,
                &liFileSize);
if (FAILED(hr))
{
    printf("Failed pfnOpenFile call [%x] %ws\n",
           hr,
           pwszFile);
           exit(1); // Or other appropriate error action.
}

// Use the opened file as needed.
// When you have finished using the file, call CertSrvBackupClose.
// ...

要件

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

こちらもご覧ください

CertSrvBackupClose

CertSrvBackupRead

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