FwpmProviderContextGetByKey0 (Compact 2013)
3/26/2014
This function retrieves a provider context.
Syntax
DWORD WINAPI FwpmProviderContextGetByKey0(
__in HANDLE engineHandle,
__in const GUID* key,
__out FWPM_PROVIDER_CONTEXT0** providerContext
);
Parameters
- engineHandle
A 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
Pointer to the address of a FWPM_PROVIDER_CONTEXT0 structure containing 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 topic WFP Error Codes for details. |
RPC_* error code 0x80010001-0x80010122 |
Failure to communicate with the remote or local firewall engine. |
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 WFP Access Right Identifiers for more information.
Requirements
Header |
fwpmu.h |
Library |
fwpuclnt.dll |
See Also
Reference
WFP Provider Context Management
WFP Functions
WFP Management Functions
FwpmProviderContextAdd0
FwpmProviderContextCreateEnumHandle0
FwpmProviderContextDeleteById0
FwpmProviderContextDeleteByKey0
FwpmProviderContextDestroyEnumHandle0
FwpmProviderContextEnum0
FwpmProviderContextGetById0
FwpmProviderContextSubscribeChanges0