FwpmProviderGetByKey0 function (fwpmk.h)
The FwpmProviderGetByKey0 function retrieves a provider.
NTSTATUS FwpmProviderGetByKey0(
[in] HANDLE engineHandle,
[in] const GUID *key,
[out] FWPM_PROVIDER0 **provider
);
[in] engineHandle
Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
[in] key
A runtime identifier for the desired object. This is the same GUID that was specified when the application called FwpmProviderAdd0.
[out] provider
The provider information.
Return code/value | Description |
---|---|
ERROR_SUCCESS 0 |
The provider was 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. |
Other NTSTATUS codes | An error occurred. |
The caller must free the returned object by a call to FwpmFreeMemory0.
The caller needs FWPM_ACTRL_READ access to the provider. See Access Control for more information.
FwpmProviderGetByKey0 is a specific implementation of FwpmProviderGetByKey. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.
Requirement | Value |
---|---|
Minimum supported client | Available starting with Windows Vista. |
Target Platform | Universal |
Header | fwpmk.h |
Library | fwpkclnt.lib |
IRQL | <= PASSIVE_LEVEL |