FwpmCalloutGetByKey0 (Compact 2013)

3/26/2014

This function retrieves a callout object.

Syntax

DWORD WINAPI FwpmCalloutGetByKey0(
  __in   HANDLE engineHandle,
  __in   const GUID* key,
  __ deref_out  FWPM_CALLOUT0** callout
);

engineHandle
[in] A handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

key
[in] A pointer to a GUID that uniquely identifies the callout. This GUID was specified in the calloutKey member of the callout parameter when the application called FwpmCalloutAdd0 for this object.

callout
[deref, out] Pointer to the address of a FWPM_CALLOUT0 structure containing the callout information.

Value	Description
ERROR_SUCCESS 0	The callout 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

ERROR_SUCCESS

The callout 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

The caller must free the returned object by a call to FwpmFreeMemory0.

The caller needs FWPM_ACTRL_READ access to the callout. See WFP Access Right Identifiers for more information.

Header	fwpmu.h
Library	fwpuclnt.dll