FBWF Manager
The FBWF Manager is a command line tool for embedded developers to quickly integrate and prototype the FBWF. FBWF Manager is intended primarily for design time use.
FBWF Manager Command Line Syntax
The FBWF Manager command line syntax follows:
fbwfmgr [/? | /help /[switch] | /displayconfig | /overlaydetail | /enable | /disable | /addvolume [volumename] | /removevolume [volumename] [1|0] | /addexclusion [path] | /removeexclusion [path] | /setthreshold [threshold] | /setcompression [1|0] | /setpreallocation [1|0] /commit [volumename] [filepath] /restore [volumename] [filepath] ]
The following table describes the command line switches.
| Switch | Description |
|---|---|
| displayconfig | Displays all configuration information for the write filter including protected volumes list, overlay configuration and write through paths. The command returns:
State—Indicating current filter state (enable or disable) and state for next boot. Protected Volumes—List of protected volumes including the current and next boot state. Compression—Current and next boot state for cache compression. Threshold—Current and next boot values for the overlay cache threshold. Write Through Paths—Displays a complete list of active and next boot write through paths. Pre-allocation Status—Displays current and next boot status for cache pre-allocation. |
| overlaydetail | Displays detail on the current overlay contents for all protected volumes. The command returns:
Contents—Files and folders currently in the overlay for all protected volumes including sizes (size of data in overlay) and open file handles. Memory Usage—Total amount of memory being consumed by the overlay. |
| enable | Enables the write filter on the next restart. |
| disable | Disables the write filter on the next restart. |
| addvolume | Adds a volume to the protected volume list for next boot. |
| removevolume | Removes a volume from the protected volume list for next boot. |
| addexclusion | Adds a write through path to the exclusion list for next boot. |
| removeexclusion | Removes a write through path from the exclusion list for next boot. |
| setthreshold | Sets the overlay threshold value for next boot. |
| setcompression | Sets overlay compression as enabled (1) or disabled (0) for next boot. |
| setpreallocation | Sets cache pre-allocation as enabled (1) or disabled (0) for next boot. |
| commit | Commits the changes made to the file to the underlying media.
The volume name can either be a case-insensitive volume device name (for example, "\\Device\\HarddiskVolume1"), or a drive letter (for example, "C:" or "D:"). Note that the name is not the volume label that Windows Explorer displays before the drive letter. The file path must be an absolute path starting with "\". Note that the volume must currently be protected. Otherwise, the error message "The system cannot find the drive specified" is displayed. |
| restore | Discards the changes made to the file, that is, restores the files to its original contents from the underlying media.
The volume name can either be a case-insensitive volume device name (for example, "\\Device\\HarddiskVolume1"), or a drive letter (for example, "C:" or "D:"). Note that the name is not the volume label that Windows Explorer displays before the drive letter. The file path must be an absolute path starting with "\". It must be a file. It is acceptable that the file was deleted, in which case it is recovered. Note that the volume must currently be protected. Otherwise, the error message "The system cannot find the drive specified" is displayed. |
| ? | Displays usage and help. |
| help / [switch] | Displays help information for a specific FBWF Manager switch. |
If no switch is provided the FBWF Manager displays all the configuration information, just like the DisplayConfig switch.
The following table describes the input parameters.
| Input field | Meaning |
|---|---|
| volumename | Full path to a volume |
| 1 | Remove exclusion list |
| 0 | Preserve exclusion list |
| path | Full file or directory path, including the drive letter.
Please note that file names are passed to fbwfmgr as a command line argument, which means backslashes and double quotes are interpreted differently. For example, |
| threshold | Overlay threshold in MB |
For comprehensive management and configuration of devices in the field, FBWF APIs are provided.
FBWF does not resolve substituted paths, use complete file names instead.
See Also
Last updated on Wednesday, October 18, 2006
© 2006 Microsoft Corporation. All rights reserved.