FesfSaDecrypt function

Decrypts a valid FESF encrypted file using a caller-provided callback.

Syntax

bool

FesfSaDecrypt(

    _In_ const wchar_t *Path,

    _In_ FE_DECRYPT_CALLBACK_ROUTINE CallbackRoutine

    _In_ void *CallbackContext,

   )

Parameters

Path [in]

A string containing the path of a file to decrypt. Refer to the Remarks section.

CallbackRoutine [in]

A pointer to a caller supplied DecryptCallback routine. Refer to the Remarks section.

CallbackContext [in]

A pointer to a caller-provided context structure passed to every invocation of the provided CallbackRoutine.

Return value

Returns TRUE if the function successfully processes all the data, FALSE otherwise.

For Windows platforms, a specific status code for this function is reported with GetLastError().

For Linux platforms, the errno variable is set.

Remarks

This function provides FESF with a path describing a file to be decrypted.  FESF calls the application provided Callback function with data blocks from the file for the callback to decrypt.  FESF does not call the Callback function with any metadata (FESF metadata or the Solution Header Data).

The file described by Path must be a valid FESF encrypted file. If it is not, an error is returned. If FESF cannot open the file described by Path for exclusive access, an error is returned.

The callback is called synchronously with respect to this function.  That is, the application’s call to Decrypt returns when all data has been supplied by FESF to the callback.

Examples

See Also

Requirements