FbwfRestoreFile (Standard 7 SP1)

7/8/2014

This function resets the cached view of the specified file.

Syntax

ULONG FbwfRestoreFile(
    LPCWSTR volume,
    LPCWSTR path
);

Parameters

  • volume
    [in] Null-terminated wide string that contains the volume name.
  • path
    [in] Null-terminated wide string that contains the file name or directory.

Return Value

This function may return the following:

Return value

Description

ERROR_SUCCESS

The operation completed successfully.

ERROR_ACCESS_DENIED

The specified file is currently not being cached by the FBWF.

ERROR_FILE_NOT_FOUND

If path refers to a directory or nonexistent file.

ERROR_INVALID_DRIVE

The specified volume is valid, but does not exist or is not protected.

ERROR_INVALID_FUNCTION

If the parameter path refers to a write-through file, a file which has been renamed, or a cached file which does not exist on the physical media.

ERROR_INVALID_PARAMETER

If the volume or path parameter is NULL.

ERROR_READ_ONLY

If path refers to a read-only file.

Remarks

This function effectively discards the cached image of the specified file. When the file is again written to, the cache will be rebuilt from the physical image and the changes will occur on the cached image.

Requirements

OS Versions: Standard 7

Header: Fbwfapi.h

Link Library: Fbwflib.lib

See Also

Reference

FbwfCommitFile

Concepts

FBWF API