MprConfigFilterGetInfo function (mprapi.h)

  • Article

The MprConfigFilterGetInfo function returns static filtering information for a specified transport protocol type.

Syntax

DWORD MprConfigFilterGetInfo(
  [in]  HANDLE hMprConfig,
  [in]  DWORD  dwLevel,
  [in]  DWORD  dwTransportId,
  [out] LPBYTE lpBuffer
);

Parameters

[in] hMprConfig

Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.

[in] dwLevel

A DWORD value that describes the format in which the information is returned in the lpBuffer parameter. Must be zero.

[in] dwTransportId

A DWORD value that describes the transport protocol type of the static filtering information in the lpBuffer parameter. Acceptable values for dwTransportId are listed in the following table.

Value Transport (Protocol Family)
PID_ATALK AppleTalk
PID_IP Internet Protocol version 4
PID_IPX Internet Packet Exchange
PID_NBF NetBIOS Frames Protocol
PID_IPV6 Windows Server 2008 or later: Internet Protocol version 6

[out] lpBuffer

On successful completion, a pointer to a MPR_FILTER_0 structure that contains the filter driver configuration information. Free this memory buffer by calling MprConfigBufferFree.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Return code Description
ERROR_INVALID_PARAMETER
 hMprConfig or lpBuffer is NULL, or dwLevel is not set to 0.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header mprapi.h
Library Mprapi.lib
DLL Mprapi.dll

See also

MPR_FILTER_0

MprConfigFilterSetInfo