PFE_IMPORT_FUNC función de devolución de llamada (winbase.h)

Artículo
08/27/2023

Una función de devolución de llamada definida por la aplicación que se usa con WriteEncryptedFileRaw. El sistema llama a ImportCallback una o varias veces, cada vez para recuperar una parte de los datos de un archivo de copia de seguridad. ImportCallback lee los datos de un archivo de copia de seguridad secuencialmente y restaura los datos, y el sistema continúa llamándolo hasta que haya leído todos los datos del archivo de copia de seguridad.

El tipo PFE_IMPORT_FUNC define un puntero a esta función de devolución de llamada. ImportCallback es un marcador de posición para el nombre de función definido por la aplicación.

Sintaxis

PFE_IMPORT_FUNC PfeImportFunc;

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

Parámetros

[in] pbData

Puntero a un búfer proporcionado por el sistema que recibirá un bloque de datos que se restaurará.

[in, optional] pvCallbackContext

Puntero a un bloque de contexto asignado y definido por la aplicación. La aplicación pasa este puntero a WriteEncryptedFileRaw y pasa este puntero a la función de devolución de llamada para que la función de devolución de llamada pueda tener acceso a datos específicos de la aplicación. Estos datos pueden ser una estructura y pueden contener los datos que necesita la aplicación, como el identificador del archivo que contiene la copia de seguridad del archivo cifrado.

[in, out] ulLength

En la entrada de función, este parámetro especifica la longitud del búfer que el sistema ha proporcionado. La función de devolución de llamada no debe escribir más de estos muchos bytes en el búfer al que apunta el parámetro pbData .

Al salir, la función debe establecer esto en el número de bytes de datos escritos en pbData.

Valor devuelto

Si la función se realiza correctamente, debe establecer el valor devuelto en ERROR_SUCCESS y establecer el valor al que apunta el parámetro ulLength en el número de bytes copiados en pbData.

Cuando se alcanza el final del archivo de copia de seguridad, establezca ulLength en cero para indicar al sistema que se ha procesado todo el archivo.

Si se produce un error en la función, establezca el valor devuelto en un código de error distinto de cero definido en WinError.h. Por ejemplo, si se produce un error en esta función porque se produce un error en una API a la que llama, puede establecer el valor devuelto en el valor devuelto por GetLastError para la API con errores.

Comentarios

El sistema llama a la función ImportCallback hasta que la función de devolución de llamada indica que no hay más datos para restaurar. Para indicar que no hay más datos que restaurar, establezca *ulLength en 0 y use un código de retorno de ERROR_SUCCESS. Puede usar el bloque de contexto definido por la aplicación para el seguimiento interno de información, como el identificador de archivo y el desplazamiento actual en el archivo.

Requisitos


Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winbase.h (incluye Windows.h)