CertSrvBackupOpenFileW, fonction (certbcli.h)

Article
08/22/2023

La fonction CertSrvBackupOpenFile ouvre un fichier pour sauvegarde.

Syntaxe

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

Paramètres

[in] hbc

Handle vers un contexte de sauvegarde des services de certificats.

[in] pwszAttachmentName

Nom de fichier à ouvrir à des fins de sauvegarde. Ce nom de fichier est analysé à partir d’une liste produite au moyen de CertSrvBackupGetBackupLogs ou CertSrvBackupGetDatabaseNames. Notez que les noms retournés par CertSrvBackupGetBackupLogs et CertSrvBackupGetDatabaseNames doivent avoir le préfixe wCHAR unique CSBFT_* supprimé avant l’appel de CertSrvBackupOpenFile .

[in] cbReadHintSize

Nombre d’octets utilisés comme indicateur lorsque le fichier est lu par CertSrvBackupRead. Le paramètre cbReadHintSize passé au premier appel CertSrvBackupOpenFile pour le contexte de sauvegarde est utilisé pour dimensionner la mémoire tampon de lecture. Passez zéro pour ce paramètre, et la mémoire tampon sera dimensionnée à une taille raisonnablement efficace choisie par CertSrvBackupOpenFile. Si la mémoire disponible est insuffisante, la taille de la mémoire tampon est réduite jusqu’à ce que l’allocation de mémoire réussisse ou jusqu’à ce que la taille de la mémoire tampon atteigne sa valeur minimale possible. Passez une taille différente de zéro pour que CertSrvBackupOpenFile dimensionne la mémoire tampon à une puissance de deux près de la valeur de cbReadHintSize. L’implémentation ne choisira que deux puissances comprises entre 64 Ko et 4 Mo.

[out] pliFileSize

Pointeur vers une valeur LARGE_INTEGER qui représente le nombre d’octets dans le fichier.

Valeur retournée

Si la fonction réussit, la fonction retourne S_OK.

Si la fonction échoue, elle retourne une valeur HRESULT qui indique l’erreur. Pour obtenir la liste des codes d’erreur courants, consultez Valeurs HRESULT courantes.

Remarques

Utilisez cette fonction pour ouvrir un fichier à des fins de sauvegarde. Lorsque vous avez terminé d’utiliser le fichier, fermez le fichier en appelant la fonction CertSrvBackupClose .

Le nom de cette fonction dans Certadm.dll est CertSrvBackupOpenFileW. Vous devez utiliser cette forme de nom lors de l’appel de GetProcAddress. En outre, cette fonction est définie comme type FNCERTSRVBACKUPOPENFILEW dans Certbcli.h.

Exemples

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

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	certbcli.h (include Certsrv.h)
Bibliothèque	Certadm.lib
DLL	Certadm.dll

Voir aussi

CertSrvBackupClose

CertSrvBackupRead

Utilisation des fonctions de sauvegarde et de restauration des services de certificat

Partager via