INetFwOpenPort::get_Scope method (netfw.h)

Article
02/22/2024

[The Windows Firewall API is > [!NOTE] > The Windows Firewall API is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. For Windows Vista and later, use of the [Windows Firewall with Advanced Security](/previous-versions/windows/desktop/ics/windows-firewall-advanced-security-start-page) API is recommended.

Controls the network scope from which the port can listen.

This property is read/write.

Syntax

HRESULT get_Scope(
  NET_FW_SCOPE *scope
);

Parameters

scope

Return value

None

Remarks

When setting the Scope property, only NET_FW_SCOPE_ALL and NET_FW_SCOPE_LOCAL_SUBNET are valid.

The default value is NET_FW_SCOPE_ALL for new ports.

To create a custom scope, use the RemoteAddresses property.

Requirements

Requirement	Value
Minimum supported client	Windows Vista, Windows XP with SP2 [desktop apps only]
Minimum supported server	Windows Server 2003 with SP1 [desktop apps only]
Target Platform	Windows
Header	netfw.h
DLL	FirewallAPI.dll; Hnetcfg.dll on Windows XP with SP2