PFN_WSK_RELEASE_DATA_INDICATION_LIST callback function

The WskRelease function releases a linked list of WSK_DATA_INDICATION structures that was previously retained by a WSK application.

WskRelease can be declared in two different ways, depending on the type of socket. This topic describes WskRelease for connection-oriented or listening sockets. For datagram sockets, see WskRelease (datagram sockets).

Syntax

PFN_WSK_RELEASE_DATA_INDICATION_LIST WskRelease;

NTSTATUS WSKAPI WSKAPI * WskRelease(
  _In_ PWSK_SOCKET          Socket,
  _In_ PWSK_DATA_INDICATION DataIndication
)
{ ... }

Parameters

  • Socket [in]
    A pointer to a WSK_SOCKET structure that specifies the socket object for the socket from which the data was received.

  • DataIndication [in]
    A pointer to the linked list of structures to be released. For this parameter, the WSK application should specify the DataIndication parameter that was passed to its WskReceiveEvent or WskReceiveFromEvent event callback function.

Return value

WskRelease returns one of the following NTSTATUS codes:

Return code Description
STATUS_SUCCESS

The list of buffers was successfully released.

STATUS_INVALID_PARAMETER

An invalid parameter was specified.

Remarks

For connection-oriented or listening sockets, a WSK application calls the WskRelease function to release a linked list of WSK_DATA_INDICATION structures that it previously retained by returning STATUS_PENDING from either its WskReceiveEvent or its WskReceiveFromEvent event callback function.

Closing a socket by calling the WskCloseSocket function does not release any outstanding retained linked lists of structures. A WSK application must release all retained linked lists of structures before the application calls the WskCloseSocket function to close the socket.

Requirements

Target platform

Universal

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

Wsk.h (include Wsk.h)

IRQL

<= DISPATCH_LEVEL

See also

WskCloseSocket

WskReceiveEvent

WskReceiveFromEvent

WSK_DATA_INDICATION

WSK_DATAGRAM_INDICATION

WSK_PROVIDER_CONNECTION_DISPATCH

WSK_PROVIDER_STREAM_DISPATCH

WSK_SOCKET

Send comments about this topic to Microsoft