Edit

Share via

PFN_FWENUMDYNAMICKEYWORDADDRESSESBYTYPE0 callback function (netfw.h)

  • Article

Function pointer type of the entry point in the service that you call to enumerate dynamic keyword addresses by type. You can request a particular subset of objects based on the enumeration flags passed in.

Note

A pointer type for this free function is published via NetFw.h, but a static-link library isn't published. Use the LoadLibraryExW/GetProcAddress pattern for calling this function.

When you call GetProcAddress, pass a handle to the firewallapi.dll module, and pass FWEnumDynamicKeywordAddressesByType0 as the lpProcName argument.

For more info, and code examples, see Firewall dynamic keywords.

Syntax

PFN_FWENUMDYNAMICKEYWORDADDRESSESBYTYPE0 PfnFwenumdynamickeywordaddressesbytype0;

DWORD PfnFwenumdynamickeywordaddressesbytype0(
  DWORD flags,
  PFW_DYNAMIC_KEYWORD_ADDRESS_DATA0 *dynamicKeywordAddressData
)
{...}

Parameters

flags

Type: DWORD

Using the value FW_DYNAMIC_KEYWORD_ADDRESS_ENUM_FLAGS_AUTO_RESOLVE will enumerate all objects that have the FW_DYNAMIC_KEYWORD_ADDRESS_FLAGS_AUTO_RESOLVE flag set.

Using the value FW_DYNAMIC_KEYWORD_ADDRESS_ENUM_FLAGS_NON_AUTO_RESOLVE will enumerate all objects that have the FW_DYNAMIC_KEYWORD_ADDRESS_FLAGS_AUTO_RESOLVE flag not set.

Using the value FW_DYNAMIC_KEYWORD_ADDRESS_ENUM_FLAGS_NON_AUTO_RESOLVE will enumerate all objects.

dynamicKeywordAddressData

Type: _Out_ PFW_DYNAMIC_KEYWORD_ADDRESS0*

The address of a pointer to a dynamic keyword address object, which will hold a linked list of objects returned. You must free this address by calling FWFreeDynamicKeywordAddressData0.

Return value

Type: DWORD

If the function succeeds, then it returns ERROR_SUCCESS. Otherwise, it returns one of the following values.

Return value Description
ERROR_INVALID_PARAMETER A zero value was passed in for the flags parameter.

Remarks

You must free the address of the first returned object in the list (the head of the list) by calling FWFreeDynamicKeywordAddressData0.

Requirements

Requirement Value
Minimum supported client Windows 10 Build 20348
Minimum supported server Windows 10 Build 20348
Target Platform Windows
Header netfw.h
DLL firewallapi.dll

See also