From 8baeda9ec7f4139bfef0549bfde1058edb826c52 Mon Sep 17 00:00:00 2001 From: basil00 Date: Wed, 6 Mar 2019 09:34:07 +0800 Subject: [PATCH] WinDivert documentation tweaks. --- doc/windivert.html | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/doc/windivert.html b/doc/windivert.html index 560cbbf..875f772 100644 --- a/doc/windivert.html +++ b/doc/windivert.html @@ -362,7 +362,7 @@ Here, the layer capabilities are: @@ -1256,11 +1256,11 @@ Receives a single captured packet/event matching the filter passed to WinDivertOpen(). The received packet/event is guaranteed to match the filter.

-Only some layers can capture packet data, as +Only some layers can capture packets/data, as summarized below:

- +
+ + + + + +
Layer @@ -1268,6 +1268,9 @@ Layer Data? +Description +
@@ -1276,6 +1279,9 @@ Data? ✔ +Network packet. +
@@ -1284,6 +1290,9 @@ Data? ✔ +Network packet. +
@@ -1291,6 +1300,9 @@ Data? +- +
@@ -1298,6 +1310,9 @@ Data? +- +
@@ -1306,12 +1321,15 @@ Data? ✔ +Filter object. +

-For layers that do support capturing, the captured packet will be written to -the pPacket buffer. +For layers that do support capturing, the captured packet/data will be written +to the pPacket buffer. If non-NULL, then the total number of bytes written to pPacket will be written to pRecvLen. If the pPacket buffer is too small, the packet will be @@ -1319,7 +1337,7 @@ truncated and the operation will fail with the ERROR_INSUFFICIENT_BUFFER error code. This error can be ignored if the application only intends to receive part of the packet, e.g., the IP headers only. -For layers that do not capture packets, the pPacket parameter +For layers that do not capture packets/data, the pPacket parameter should be NULL and packetLen should be zero.

If non-NULL, the address of the