Share via


FbwfCommitFile (Standard 8)

7/8/2014

Review the use, syntax, parameters, and return values of the FbwfCommitFile function of the FBWF API in Windows Embedded 8 Standard (Standard 8).

This function writes the cached file overlay to the physical disk file.

Syntax

ULONG FbwfCommitFile(
    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 or directory.

Return Value

The following table shows the possible return values.

Value

Description

ERROR_SUCCESS

The operation completed successfully.

ERROR_FILE_NOT_FOUND

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

ERROR_INVALID_DRIVE

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

ERROR_INVALID_FUNCTION

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

ERROR_INVALID_PARAMETER

The volume or path parameter is NULL.

ERROR_WRITE_PROTECT

The volume is read-only.

Other standard HRESULT error codes may be returned if the system fails to update the configuration file.

Remarks

This function is used to write the image of the file in the FBWF cache to disk. This does not stop write protection for the specified file.

Requirements

Header

fbwfapi.h

Library

fbwflib.lib

See Also

Concepts

FBWF API Functions