Compartilhar via


Função CertSrvBackupOpenFileW (certbcli.h)

A função CertSrvBackupOpenFile abre um arquivo para backup.

Sintaxe

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

Parâmetros

[in] hbc

Um identificador para um contexto de backup dos Serviços de Certificados .

[in] pwszAttachmentName

Nome do arquivo a ser aberto para fins de backup. Esse nome de arquivo seria analisado de uma lista produzida por meio de CertSrvBackupGetBackupLogs ou CertSrvBackupGetDatabaseNames. Observe que os nomes retornados por CertSrvBackupGetBackupLogs e CertSrvBackupGetDatabaseNames devem ter o prefixo CSBFT_* de WCHAR único removido antes que CertSrvBackupOpenFile seja chamado.

[in] cbReadHintSize

Número de bytes usados como uma dica quando o arquivo é lido por CertSrvBackupRead. O parâmetro cbReadHintSize passado para a primeira chamada de CertSrvBackupOpenFile para o contexto de backup é usado para dimensionar o buffer de leitura. Passe zero para esse parâmetro e o buffer será dimensionado em um tamanho razoavelmente eficiente escolhido por CertSrvBackupOpenFile. Se a memória insuficiente estiver disponível, o tamanho do buffer será reduzido até que a alocação de memória seja bem-sucedida ou até que o tamanho do buffer atinja seu valor mínimo possível. Passe um tamanho diferente de zero para fazer com que CertSrvBackupOpenFile dimensione o buffer para uma potência de dois próximo ao valor de cbReadHintSize. A implementação escolherá apenas potências de dois entre 64 KB e 4 MB.

[out] pliFileSize

Um ponteiro para um valor LARGE_INTEGER que representa o número de bytes no arquivo.

Retornar valor

Se a função for bem-sucedida, a função retornará S_OK.

Se a função falhar, ela retornará um valor HRESULT que indica o erro. Para obter uma lista de códigos de erro comuns, consulte Valores HRESULT comuns.

Comentários

Use essa função para abrir um arquivo para fins de backup. Quando terminar de usar o arquivo, feche o arquivo chamando a função CertSrvBackupClose .

O nome dessa função no Certadm.dll é CertSrvBackupOpenFileW. Você deve usar essa forma do nome ao chamar GetProcAddress. Além disso, essa função é definida como o tipo FNCERTSRVBACKUPOPENFILEW em Certbcli.h.

Exemplos

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

Requisitos

Requisito Valor
Cliente mínimo com suporte Nenhum compatível
Servidor mínimo com suporte Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho certbcli.h (inclua Certsrv.h)
Biblioteca Certadm.lib
DLL Certadm.dll

Confira também

CertSrvBackupClose

CertSrvBackupRead

Usando as funções de backup e restauração dos Serviços de Certificados