diff options
| author | Barry Golden <[email protected]> | 2019-09-16 14:04:28 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2019-09-16 14:04:28 -0700 |
| commit | f064dfb2d92ac3f1f4344d435e4690e4339b5025 (patch) | |
| tree | a807973e6c0bd9e2c92b3b8cf7ecb5f9e63c28d2 /filesys/miniFilter | |
| parent | db43355fe49c4bec3dbb5f84c271e15dc914ce72 (diff) | |
Update README.md (#417)84625846248462384622846218462084619846188461784616846158461484613846128461184610846098460884607846068460584604
Diffstat (limited to 'filesys/miniFilter')
| -rw-r--r-- | filesys/miniFilter/MetadataManager/README.md | 12 | ||||
| -rw-r--r-- | filesys/miniFilter/NameChanger/README.md | 9 | ||||
| -rw-r--r-- | filesys/miniFilter/avscan/README.md | 10 | ||||
| -rw-r--r-- | filesys/miniFilter/cancelSafe/README.md | 15 | ||||
| -rw-r--r-- | filesys/miniFilter/cdo/README.md | 15 | ||||
| -rw-r--r-- | filesys/miniFilter/change/README.md | 12 | ||||
| -rw-r--r-- | filesys/miniFilter/ctx/README.md | 12 | ||||
| -rw-r--r-- | filesys/miniFilter/delete/README.md | 15 | ||||
| -rw-r--r-- | filesys/miniFilter/minispy/README.md | 12 | ||||
| -rw-r--r-- | filesys/miniFilter/nullFilter/README.md | 12 | ||||
| -rw-r--r-- | filesys/miniFilter/passThrough/README.md | 12 | ||||
| -rw-r--r-- | filesys/miniFilter/scanner/README.md | 12 | ||||
| -rw-r--r-- | filesys/miniFilter/simrep/README.md | 12 | ||||
| -rw-r--r-- | filesys/miniFilter/swapBuffers/README.md | 12 |
14 files changed, 16 insertions, 156 deletions
diff --git a/filesys/miniFilter/MetadataManager/README.md b/filesys/miniFilter/MetadataManager/README.md index abb9cf24..aae5ea2c 100644 --- a/filesys/miniFilter/MetadataManager/README.md +++ b/filesys/miniFilter/MetadataManager/README.md @@ -8,16 +8,6 @@ products: - windows-wdk --- - -<!--- - name: Metadata Manager File System Minifilter Driver - platform: WDM - language: cpp - category: FileSystem - description: An example of how to use files for storing metadata that corresponds to minifilters. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617650 ----> - # Metadata Manager File System Minifilter Driver The Metadata Manager minifilter sample serves as an example if you want to use files for storing metadata that corresponds to your minifilters. The implementation of this sample depicts scenarios in which modifications to the file might have to be blocked or the minifilter might be required to close the file temporarily. @@ -36,4 +26,4 @@ Similarly, the minifilter might close its metadata file if it sees an explicit F The metadata minifilter also handles the case when a snapshot of its volume object is being taken. In this scenario, the minifilter acquires a shared exclusive lock on the metadata resource object while calling the callback that corresponds to the pre-device control operation for IOCTL\_VOLSNAP\_FLUSH\_AND\_HOLD\_WRITES. The lock is later released in the callback that corresponds to the post-device control operation for IOCTL\_VOLSNAP\_FLUSH\_AND\_HOLD\_WRITES. The lock is acquired to prevent any modifications on the metadata file while the snapshot is being taken. -For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
\ No newline at end of file +For more information on file system minifilter design, start with the [File System Minifilter Drivers](https://docs.microsoft.com/windows-hardware/drivers/ifs/file-system-minifilter-drivers) section in the Installable File Systems Design Guide. diff --git a/filesys/miniFilter/NameChanger/README.md b/filesys/miniFilter/NameChanger/README.md index dd25409d..440cf30d 100644 --- a/filesys/miniFilter/NameChanger/README.md +++ b/filesys/miniFilter/NameChanger/README.md @@ -8,15 +8,6 @@ products: - windows-wdk --- -<!--- - name: NameChanger File System Minifilter Driver - platform: WDM - language: cpp - category: FileSystem - description: Grafts a directory from one part of a volume's namespace to another part using a mapping. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617652 ----> - # NameChanger File System Minifilter Driver The *NameChanger* minifilter grafts a directory from one part of a volume's namespace to another part using a mapping. The minifilter maintains this illusion by acting as a name provider, injecting entries into directory enumerations and forwarding directory change notifications. diff --git a/filesys/miniFilter/avscan/README.md b/filesys/miniFilter/avscan/README.md index f511c906..baca08f9 100644 --- a/filesys/miniFilter/avscan/README.md +++ b/filesys/miniFilter/avscan/README.md @@ -8,16 +8,6 @@ products: - windows-wdk --- - -<!--- - name: AvScan File System Minifilter Driver - platform: WDM - language: cpp - category: FileSystem - description: This filter is a transaction-aware file scanner that examines data in files. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617644 ----> - # AvScan File System Minifilter Driver The AvScan minifilter is a transaction-aware file scanner. This is an example for developers who intend to write filters that examine data in files. Typically, anti-virus products fall into this category. diff --git a/filesys/miniFilter/cancelSafe/README.md b/filesys/miniFilter/cancelSafe/README.md index bd85bcbf..67a8ee19 100644 --- a/filesys/miniFilter/cancelSafe/README.md +++ b/filesys/miniFilter/cancelSafe/README.md @@ -8,16 +8,6 @@ products: - windows-wdk --- - -<!--- - name: CancelSafe File System Minifilter Driver - platform: WDM - language: cpp - category: FileSystem - description: A minifilter demonstrating the use of cancel-safe queues. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617645 ----> - # CancelSafe File System Minifilter Driver The CancelSafe filter is a sample minifilter that you use if you want to use cancel-safe queues. @@ -26,9 +16,8 @@ The CancelSafe filter is a sample minifilter that you use if you want to use can This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP. -Design and Operation --------------------- +## Design and Operation The *CancelSafe* minifilter initializes a cancel-safe queue when it is attached to a volume. When the minifilter is deployed, it monitors read operations that are passing through the I/O stack. If the read operation is being performed on a file named csqdemo.txt, it is queued onto the cancel-safe queue. Queued operations are completed after a brief pause through a separate worker thread that is running in system context. -For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide. +For more information on file system minifilter design, start with the [File System Minifilter Drivers](https://docs.microsoft.com/windows-hardware/drivers/ifs/file-system-minifilter-drivers) section in the Installable File Systems Design Guide. diff --git a/filesys/miniFilter/cdo/README.md b/filesys/miniFilter/cdo/README.md index 2eb2513e..af1bd3f6 100644 --- a/filesys/miniFilter/cdo/README.md +++ b/filesys/miniFilter/cdo/README.md @@ -8,16 +8,6 @@ products: - windows-wdk --- - -<!--- - name: CDO File System Minifilter Driver - platform: WDM - language: cpp - category: FileSystem - description: An example of using a control device object (CDO) with a minifilter. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617646 ----> - # CDO File System Minifilter Driver The CDO minifilter sample is an example if you intend to use a control device object (CDO) with your minifilters. @@ -28,9 +18,8 @@ Although the filter manager infrastructure provides a message interface for comm This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP. -Design and Operation --------------------- +## Design and Operation When the CDO minifilter is deployed, it creates a CDO object named "FileSystem\\Filters\\CdoSample" in the Microsoft Windows object namespace and enables applications to open it and perform certain operations on it. -For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
\ No newline at end of file +For more information on file system minifilter design, start with the [File System Minifilter Drivers](https://docs.microsoft.com/windows-hardware/drivers/ifs/file-system-minifilter-drivers) section in the Installable File Systems Design Guide. diff --git a/filesys/miniFilter/change/README.md b/filesys/miniFilter/change/README.md index 1f370ce9..f7e2be09 100644 --- a/filesys/miniFilter/change/README.md +++ b/filesys/miniFilter/change/README.md @@ -8,16 +8,6 @@ products: - windows-wdk --- - -<!--- - name: Change File System Minifilter Driver - platform: WDM - language: cpp - category: FileSystem - description: A transaction-aware filter that monitors file changes in real time. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617647 ----> - # Change File System Minifilter Driver The Change minifilter is a transaction-aware filter that monitors file changes in real time. @@ -33,4 +23,4 @@ The primary tasks of the filter for tracking a transacted file are the following ## Universal Windows Driver Compliant -This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP.
\ No newline at end of file +This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP. diff --git a/filesys/miniFilter/ctx/README.md b/filesys/miniFilter/ctx/README.md index 3218cad9..c428b6ae 100644 --- a/filesys/miniFilter/ctx/README.md +++ b/filesys/miniFilter/ctx/README.md @@ -8,16 +8,6 @@ products: - windows-wdk --- - -<!--- - name: Ctx File System Minifilter Driver - platform: WDM - language: cpp - category: FileSystem - description: Demonstrates how to attach contexts to instances, files, streams, and stream handles in your minifilter. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617648 ----> - # Ctx File System Minifilter Drive The Ctx minifilter is an example that demonstrates how to attach contexts to instances, files, streams, and stream handles in your minifilter. @@ -30,4 +20,4 @@ This sample builds a Universal Windows Driver. It uses only APIs and DDIs that a The *Ctx* minifilter demonstrates how to attach and remove contexts from instances, files, steams, and stream handles. *Ctx* attaches a context whenever one of these objects is created. While attaching a context to a file, the sample also creates a stream and stream handle context. All contexts are ultimately deleted by the filter manager using the callback function that the *Ctx* minifilter provides. -For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
\ No newline at end of file +For more information on file system minifilter design, start with the [File System Minifilter Drivers](https://docs.microsoft.com/windows-hardware/drivers/ifs/file-system-minifilter-drivers) section in the Installable File Systems Design Guide. diff --git a/filesys/miniFilter/delete/README.md b/filesys/miniFilter/delete/README.md index 82493c94..687a33af 100644 --- a/filesys/miniFilter/delete/README.md +++ b/filesys/miniFilter/delete/README.md @@ -8,16 +8,6 @@ products: - windows-wdk --- - -<!--- - name: Delete File System Minifilter Driver - platform: WDM - language: cpp - category: FileSystem - description: Demonstrates how to detect deletions of files or streams. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617649 ----> - # Delete File System Minifilter Driver The Delete minifilter is an example that demonstrates how to detect deletions of files or streams. Deletions are reported as debug output. @@ -30,6 +20,7 @@ This sample builds a Universal Windows Driver. It uses only APIs and DDIs that a The *delete* minifilter illustrates how to detect deletion of files and streams. It monitors IRP\_MJ\_CREATE requests for the FILE\_DELETE\_ON\_CLOSE flag. Also, it detects IRP\_MJ\_SET\_INFORMATION requests for setting FileDispositionInformation/FileDispositionInformationEx. The sample also illustrates how to handle racing deletes (in the form of multiple parallel IRP\_MJ\_SET\_INFORMATION operations), and how to distinguish deletion of an entire file from deletion of just one stream of the file. -**Note** Because of the way in which the Windows operating system deletes files, it is not possible for the minifilter to detect in advance that a file or stream will be deleted. The minifilter can only detect operations that may cause a deletion, and then determine if the deletion took place after the operation completes. +> [!NOTE] +> Because of the way in which the Windows operating system deletes files, it is not possible for the minifilter to detect in advance that a file or stream will be deleted. The minifilter can only detect operations that may cause a deletion, and then determine if the deletion took place after the operation completes. -For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
\ No newline at end of file +For more information on file system minifilter design, start with the [File System Minifilter Drivers](https://docs.microsoft.com/windows-hardware/drivers/ifs/file-system-minifilter-drivers) section in the Installable File Systems Design Guide. diff --git a/filesys/miniFilter/minispy/README.md b/filesys/miniFilter/minispy/README.md index fd3bd920..6ff47310 100644 --- a/filesys/miniFilter/minispy/README.md +++ b/filesys/miniFilter/minispy/README.md @@ -8,16 +8,6 @@ products: - windows-wdk --- - -<!--- - name: Minispy File System Minifilter Driver - platform: WDM - language: cpp - category: FileSystem - description: A tool to monitor and log any I/O and transaction activity that occurs in the system. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617651 ----> - # Minispy File System Minifilter Driver The Minispy sample is a tool to monitor and log any I/O and transaction activity that occurs in the system. Minispy is implemented as a minifilter. @@ -32,4 +22,4 @@ Minispy consists of both user-mode and kernel-mode components. The kernel-mode c To observe I/O activity on a device, you must explicitly attach Minispy to that device by using the Minispy user-mode component. Similarly, you can request Minispy to stop logging data for a particular device. -For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
\ No newline at end of file +For more information on file system minifilter design, start with the [File System Minifilter Drivers](https://docs.microsoft.com/windows-hardware/drivers/ifs/file-system-minifilter-drivers) section in the Installable File Systems Design Guide. diff --git a/filesys/miniFilter/nullFilter/README.md b/filesys/miniFilter/nullFilter/README.md index b4930c26..204588c1 100644 --- a/filesys/miniFilter/nullFilter/README.md +++ b/filesys/miniFilter/nullFilter/README.md @@ -8,16 +8,6 @@ products: - windows-wdk --- - -<!--- - name: NullFilter File System Minifilter Driver - platform: WDM - language: cpp - category: FileSystem - description: A minifilter that demonstrates registration with the filter manager. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617653 ----> - # NullFilter File System Minifilter Driver The NullFilter minifilter is a sample minifilter that shows how to register a minifilter with the filter manager. @@ -30,4 +20,4 @@ This sample builds a Universal Windows Driver. It uses only APIs and DDIs that a The *NullFilter* minifilter is a simple minifilter that registers itself with the filter manager for no callback operations. -For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
\ No newline at end of file +For more information on file system minifilter design, start with the [File System Minifilter Drivers](https://docs.microsoft.com/windows-hardware/drivers/ifs/file-system-minifilter-drivers) section in the Installable File Systems Design Guide. diff --git a/filesys/miniFilter/passThrough/README.md b/filesys/miniFilter/passThrough/README.md index cae7eb0c..766c1cdf 100644 --- a/filesys/miniFilter/passThrough/README.md +++ b/filesys/miniFilter/passThrough/README.md @@ -8,16 +8,6 @@ products: - windows-wdk --- - -<!--- - name: PassThrough File System Minifilter Driver - platform: WDM - language: cpp - category: FileSystem - description: Demonstrates how to specify callback functions for different types of I/O requests. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617654 ----> - # PassThrough File System Minifilter Driver The PassThrough minifilter demonstrates how to specify callback functions for different types of I/O requests. @@ -30,4 +20,4 @@ This sample builds a Universal Windows Driver. It uses only APIs and DDIs that a The *PassThrough* minifilter does not have any real functionality. For each type of I/O operation, the same pre and post callback functions are called. These callback functions simply forward the I/O request to the next filter on the stack. -For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
\ No newline at end of file +For more information on file system minifilter design, start with the [File System Minifilter Drivers](https://docs.microsoft.com/windows-hardware/drivers/ifs/file-system-minifilter-drivers) section in the Installable File Systems Design Guide. diff --git a/filesys/miniFilter/scanner/README.md b/filesys/miniFilter/scanner/README.md index 0719c3fd..f4e8c8d6 100644 --- a/filesys/miniFilter/scanner/README.md +++ b/filesys/miniFilter/scanner/README.md @@ -8,16 +8,6 @@ products: - windows-wdk --- - -<!--- - name: Scanner File System Minifilter Driver - platform: WDM - language: cpp - category: FileSystem - description: A file data scanner example. Typically, anti-virus filters are of this type. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617655 ----> - # Scanner File System Minifilter Driver The Scanner minifilter is an example for developers who intend to write filters that examine data in files. Typically, antivirus products fall into this category. @@ -32,4 +22,4 @@ The Scanner minifilter comprises both kernel-mode and user-mode components. The The kernel-mode component scans files with specific extensions only. The file is first scanned on a successful open. If the file was opened with write access, it is scanned again before a close. Scanning is also performed on data that is about to be written to a file. Writes will be rejected if any occurrences of a "foul" string are found in the data. If a "foul" string is detected during the closing of a file, a debug message is printed. -For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
\ No newline at end of file +For more information on file system minifilter design, start with the [File System Minifilter Drivers](https://docs.microsoft.com/windows-hardware/drivers/ifs/file-system-minifilter-drivers) section in the Installable File Systems Design Guide. diff --git a/filesys/miniFilter/simrep/README.md b/filesys/miniFilter/simrep/README.md index d8b7eefc..4f02ed2b 100644 --- a/filesys/miniFilter/simrep/README.md +++ b/filesys/miniFilter/simrep/README.md @@ -8,16 +8,6 @@ products: - windows-wdk --- - -<!--- - name: SimRep File System Minifilter Driver - platform: WDM - language: cpp - category: FileSystem - description: Demonstrates how a file system filter can simulate file-system like reparse-point behavior to redirect a file open to an alternate path. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617656 ----> - # SimRep File System Minifilter Driver SimRep is a sample filter that demonstrates how a file system filter can simulate file-system like reparse-point behavior to redirect a file open to an alternate path. @@ -34,4 +24,4 @@ SimRep decides to reparse according to a mapping. The mapping is made up of a "N It is important to note that SimRep does not take long and short names into account. It literally does a string comparison to detect overlap with the mapping paths. SimRep also handles IRP\_MJ\_NETWORK\_QUERY\_OPEN. Because network query opens are FastIo operations, they cannot be reparsed. This means network query opens which need to be redirected must be failed with FLT\_PREOP\_DISALLOW\_FASTIO. This will cause the Io Manager to reissue the open as a regular IRP based open. To prevent performance regression, SimRep only fails network query opens which need to be reparsed. -For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide. +For more information on file system minifilter design, start with the [File System Minifilter Drivers](https://docs.microsoft.com/windows-hardware/drivers/ifs/file-system-minifilter-drivers) section in the Installable File Systems Design Guide. diff --git a/filesys/miniFilter/swapBuffers/README.md b/filesys/miniFilter/swapBuffers/README.md index 292edea9..f427685f 100644 --- a/filesys/miniFilter/swapBuffers/README.md +++ b/filesys/miniFilter/swapBuffers/README.md @@ -8,16 +8,6 @@ products: - windows-wdk --- - -<!--- - name: SwapBuffer File System Minifilter Driver - platform: WDM - language: cpp - category: FileSystem - description: Demonstrates how to switch buffers between reads and writes of data. This technique is particularly useful for encryption filters. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617657 ----> - # SwapBuffer File System Minifilter Driver The SwapBuffers minifilter demonstrates how to switch buffers between reads and writes of data. This technique is particularly useful for encryption filters because they have to encrypt data before writing it to disk and decrypt it after reading it from disk. Because encryption/decryption has to be done transparently, you cannot use system-supplied buffers directly, so intermediate buffers have to be introduced. @@ -30,4 +20,4 @@ This sample builds a Universal Windows Driver. It uses only APIs and DDIs that a The *SwapBuffers* minifilter introduces a new buffer before a read/write or directory control operations. The corresponding operation is then performed on the new buffer instead of the buffer that was originally provided. After the operation completes, the contents of the new buffer are copied back in to the original buffer. -For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide. +For more information on file system minifilter design, start with the [File System Minifilter Drivers](https://docs.microsoft.com/windows-hardware/drivers/ifs/file-system-minifilter-drivers) section in the Installable File Systems Design Guide. |
