FwpmProviderContextGetByKey0 function (fwpmk.h)
The FwpmProviderContextGetByKey0 function retrieves a provider context.
Syntax
NTSTATUS FwpmProviderContextGetByKey0(
[in] HANDLE engineHandle,
const GUID *key,
FWPM_PROVIDER_CONTEXT0 **providerContext
);
Parameters
[in] engineHandle
Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
key
Pointer to a GUID that uniquely identifies the provider context. This is a pointer to the same GUID that was specified when the application called FwpmProviderContextAdd0 for this object.
providerContext
The provider context information.
Return value
Return code/value | Description |
---|---|
ERROR_SUCCESS 0 |
The provider context 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. |
Remarks
The caller must free the returned object by a call to FwpmFreeMemory0.
The caller needs FWPM_ACTRL_READ access to the provider context. See Access Control for more information.
FwpmProviderContextGetByKey0 is a specific implementation of FwpmProviderContextGetByKey. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Available starting with Windows Vista. |
Target Platform | Universal |
Header | fwpmk.h |
Library | fwpkclnt.lib |
IRQL | <= PASSIVE_LEVEL |
See also
Here are all the links in the current document: