CertSrvBackupOpenFileW-Funktion (certbcli.h)

Artikel
08/22/2023

Die CertSrvBackupOpenFile-Funktion öffnet eine Datei zur Sicherung.

Syntax

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

Parameter

[in] hbc

Ein Handle für einen Zertifikatdienste-Sicherungskontext .

[in] pwszAttachmentName

Dateiname, der zu Sicherungszwecken geöffnet werden soll. Dieser Dateiname wird aus einer Liste analysiert, die mithilfe von CertSrvBackupGetBackupLogs oder CertSrvBackupGetDatabaseNames erstellt wird. Beachten Sie, dass für die von CertSrvBackupGetBackupLogs und CertSrvBackupGetDatabaseNames zurückgegebenen Namen das Präfix single-WCHAR CSBFT_* entfernt sein muss, bevor CertSrvBackupOpenFile aufgerufen wird.

[in] cbReadHintSize

Anzahl der Bytes, die als Hinweis verwendet werden, wenn die Datei von CertSrvBackupRead gelesen wird. Der cbReadHintSize-Parameter , der an den ersten CertSrvBackupOpenFile-Aufruf für den Sicherungskontext übergeben wird, wird verwendet, um den Lesepuffer zu vergrößern. Übergeben Sie null für diesen Parameter, und der Puffer wird mit einer relativ effizienten Größe dimensioniert, die von CertSrvBackupOpenFile ausgewählt wird. Wenn nicht genügend Arbeitsspeicher verfügbar ist, wird die Puffergröße reduziert, bis die Speicherzuordnung erfolgreich ist oder bis die Puffergröße ihren minimal möglichen Wert erreicht. Übergeben Sie eine nichtzero-Größe, damit CertSrvBackupOpenFile die Größe des Puffers auf eine Leistung von zwei nahe dem Wert von cbReadHintSize angibt. Die Implementierung wählt nur zwei Powern zwischen 64 KB und 4 MB.

[out] pliFileSize

Ein Zeiger auf einen LARGE_INTEGER Wert, der die Anzahl der Bytes in der Datei darstellt.

Rückgabewert

Wenn die Funktion erfolgreich ist, gibt die Funktion S_OK zurück.

Wenn die Funktion fehlschlägt, gibt sie einen HRESULT-Wert zurück, der den Fehler angibt. Eine Liste allgemeiner Fehlercodes finden Sie unter Allgemeine HRESULT-Werte.

Hinweise

Verwenden Sie diese Funktion, um eine Datei zu Sicherungszwecken zu öffnen. Wenn Sie die Datei verwendet haben, schließen Sie die Datei, indem Sie die CertSrvBackupClose-Funktion aufrufen.

Der Name dieser Funktion in Certadm.dll lautet CertSrvBackupOpenFileW. Sie müssen diese Form des Namens verwenden, wenn Sie GetProcAddress aufrufen. Außerdem wird diese Funktion als Typ FNCERTSRVBACKUPOPENFILEW in Certbcli.h definiert.

Beispiele

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.
// ...

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Nicht unterstützt
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	certbcli.h (include Certsrv.h)
Bibliothek	Certadm.lib
DLL	Certadm.dll

Weitere Informationen

CertSrvBackupClose

CertSrvBackupRead

Verwenden der Sicherungs- und Wiederherstellungsfunktionen für Zertifikatdienste

Freigeben über