PFE_IMPORT_FUNC função de retorno de chamada (winbase.h)

Artigo
08/27/2023

Uma função de retorno de chamada definida pelo aplicativo usada com WriteEncryptedFileRaw. O sistema chama ImportCallback uma ou mais vezes, cada vez para recuperar uma parte dos dados de um arquivo de backup. ImportCallback lê os dados de um arquivo de backup sequencialmente e restaura os dados, e o sistema continua chamando-os até que ele leia todos os dados do arquivo de backup.

O tipo PFE_IMPORT_FUNC define um ponteiro para essa função de retorno de chamada. ImportCallback é um espaço reservado para o nome da função definida pelo aplicativo.

Sintaxe

PFE_IMPORT_FUNC PfeImportFunc;

DWORD PfeImportFunc(
  [in]           PBYTE pbData,
  [in, optional] PVOID pvCallbackContext,
  [in, out]      PULONG ulLength
)
{...}

Parâmetros

[in] pbData

Um ponteiro para um buffer fornecido pelo sistema que receberá um bloco de dados a ser restaurado.

[in, optional] pvCallbackContext

Um ponteiro para um bloco de contexto definido pelo aplicativo e alocado. O aplicativo passa esse ponteiro para WriteEncryptedFileRaw e passa esse ponteiro para a função de retorno de chamada para que a função de retorno de chamada possa ter acesso a dados específicos do aplicativo. Esses dados podem ser uma estrutura e podem conter quaisquer dados de que o aplicativo precise, como o identificador para o arquivo que contém a cópia de backup do arquivo criptografado.

[in, out] ulLength

Na entrada da função, esse parâmetro especifica o comprimento do buffer que o sistema forneceu. A função de retorno de chamada não deve gravar mais do que tantos bytes no buffer apontado pelo parâmetro pbData .

Na saída, a função deve definir isso como o número de bytes de dados gravados no pbData.

Valor retornado

Se a função for bem-sucedida, ela deverá definir o valor retornado como ERROR_SUCCESS e definir o valor apontado pelo parâmetro ulLength como o número de bytes copiados em pbData.

Quando o final do arquivo de backup for atingido, defina ulLength como zero para informar ao sistema que todo o arquivo foi processado.

Se a função falhar, defina o valor retornado como um código de erro diferente de zero definido em WinError.h. Por exemplo, se essa função falhar porque uma API que ela chama falhar, você poderá definir o valor retornado para o valor retornado por GetLastError para a API com falha.

Comentários

O sistema chama a função ImportCallback até que a função de retorno de chamada indique que não há mais dados a serem restaurados. Para indicar que não há mais dados a serem restaurados, defina *ulLength como 0 e use um código de retorno de ERROR_SUCCESS. Você pode usar o bloco de contexto definido pelo aplicativo para acompanhamento interno de informações, como o identificador de arquivo e o deslocamento atual no arquivo.

Requisitos


Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winbase.h (incluir Windows.h)