PFN_WSK_RELEASE_DATAGRAM_INDICATION_LIST callback function (wsk.h)

Article
02/22/2024

The WskRelease function releases a linked list of WSK_DATAGRAM_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 datagram sockets. For connection-oriented or listening sockets, see WskRelease (connection-oriented or listening sockets).

Syntax

PFN_WSK_RELEASE_DATAGRAM_INDICATION_LIST PfnWskReleaseDatagramIndicationList;

NTSTATUS PfnWskReleaseDatagramIndicationList(
  [in] PWSK_SOCKET Socket,
  [in] PWSK_DATAGRAM_INDICATION DatagramIndication
)
{...}

Parameters

[in] Socket

A pointer to a WSK_SOCKET structure that specifies the socket object for the socket from which the data was received.

[in] DatagramIndication

A pointer to the linked list of structures to be released. For this parameter, the WSK application should specify the DatagramIndication 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 structures was successfully released.
STATUS_INVALID_PARAMETER	An invalid parameter was specified.

Remarks

A WSK application calls the WskRelease function to release a linked list of WSK_DATAGRAM_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

Requirement	Value
Minimum supported client	Available in Windows Vista and later versions of the Windows operating systems.
Target Platform	Universal
Header	wsk.h (include Wsk.h)
IRQL	<= DISPATCH_LEVEL