FwpmSubLayerSubscriptionsGet0 function

The FwpmSubLayerSubscriptionsGet0 function retrieves an array of all the current sub-layer change notification subscriptions.

Syntax

DWORD FwpmSubLayerSubscriptionsGet0(
  HANDLE                      engineHandle,
  FWPM_SUBLAYER_SUBSCRIPTION0 ***entries,
  UINT32                      *numEntries
);

Parameters

engineHandle

Type: HANDLE

Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

entries

Type: FWPM_SUBLAYER_SUBSCRIPTION0***

The current sublayer change notification subscriptions.

numEntries

Type: UINT32*

The number of entries returned.

Return Value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
The subscriptions were retrieved successfully.
FWP_E_* error code
0x80320001—0x80320039
A Windows Filtering Platform (WFP) specific error. See WFP Error Codes for details.
RPC_* error code
0x80010001—0x80010122
Failure to communicate with the remote or local firewall engine.

Remarks

The returned array (but not the individual entries in the array) must be freed through a call to FwpmFreeMemory0.

The caller needs FWPM_ACTRL_READ access to the sublayer's container. See Access Control for more information.

FwpmSubLayerSubscriptionsGet0 is a specific implementation of FwpmSubLayerSubscriptionsGet. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header fwpmu.h
Library Fwpuclnt.lib
DLL Fwpuclnt.dll

See Also

FWPM_SUBLAYER_SUBSCRIPTION0