FwpsQueryConnectionSioFormatRedirectRecords0 function (fwpsk.h)

Article
10/21/2021

The FwpsQueryConnectionSioFormatRedirectRecords0 function returns the connection redirect records for a redirected connection. For more information about redirection, see Using Bind or Connect Redirection.

Note FwpsQueryConnectionSioFormatRedirectRecords0 is a specific version of FwpsQueryConnectionSioFormatRedirectRecords. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Syntax

NTSTATUS FwpsQueryConnectionSioFormatRedirectRecords0(
  [in]            HANDLE  RedirectRecords,
  [out, optional] PVOID   OutputBuffer,
  [in]            SIZE_T  OutputBufferLength,
  [out, optional] PSIZE_T BytesTransferred
);

Parameters

[in] RedirectRecords

The redirect records handle that the ALE_CONNECT_REDIRECT callout function received in the inMetaValues parameter of its classifyFn function. This handle can be found in the redirectRecords member of the FWPS_INCOMING_METADATA_VALUES0 structure.

A WFP redirect record is a buffer of opaque data that WFP must set on an outbound proxy connection so that the redirected connection and the original connection are logically related.

[out, optional] OutputBuffer

A pointer to an output buffer that receives the redirect records. The buffer must be pointer-aligned.

[in] OutputBufferLength

The size, in bytes, of the output buffer.

[out, optional] BytesTransferred

A pointer to a variable that receives the number of bytes that were transferred. If the return value is STATUS_BUFFER_TOO_SMALL, this parameter receives the required buffer size.

Return value

Returns an NTSTATUS value such as one of the following.

Return code	Description
STATUS_BUFFER_TOO_SMALL	The output buffer was too small to contain all of the bytes to be transferred. The data transfer failed, and the required buffer size can be found in the BytesTransferred parameter.
STATUS_NOT_FOUND	The RedirectRecords parameter was null.

Remarks

The FwpsQueryConnectionSioFormatRedirectRecords0 function applies only to local proxies.

For more information about redirection, see Using Bind or Connect Redirection.

The FwpsQueryConnectionSioFormatRedirectRecords0 function is designed to be used by a WFP connection redirection callout driver that doesn't accept the redirected connection until it has verified that it is able to connect to the actual remote endpoint. To do this, the callout driver pends the redirected connection request at the FWPS_LAYER_ALE_CONNECT_REDIRECT_V4 or FWPS_LAYER_ALE_CONNECT_REDIRECT_V6 layer and calls FwpsQueryConnectionSioFormatRedirectRecords0 to retrieve the connection redirect records, which the callout driver then sends to the proxy to be used in a call to SIO_SET_WFP_CONNECTION_REDIRECT_RECORDS.

Requirements

Requirement	Value
Minimum supported client	Windows 7
Minimum supported server	Windows Server 2008 R2
Target Platform	Universal
Header	fwpsk.h (include Fwpsk.h)
Library	Fwpkclnt.lib
IRQL	<=DISPATCH_LEVEL