On this page
API type

network

Controls WinDivert network capture.

Syntax

Atlas Script
network

Return value

See the remarks for the returned value and runtime behavior.

Remarks

Controls WinDivert network capture. network.capture(filter) starts it (one administrator prompt per Run) and network.stop() ends it. network.active, network.error, network.interface and the received, sent, dropped and failed_open counters report its state. Every member can be used in any event or function, but capture starts only while the script is running: network.capture() works in on_start, on_connect, on_frame, on_input, on_network_recv and on_network_send (and functions they call), and returns false in global initializers and on_stop, with network.error saying why.

Examples

Usage pattern
// network is available where its documented API returns or accepts this value.
Reference details are generated from the Atlas Script schema in this documentation source snapshot. Confirm release-specific behavior in the Atlas for Windows build you use.