WdsTransportClientCompleteReceive function (wdstci.h)

Article
02/22/2024

Indicates that all processing on a block of data is finished, and that the multicast client may purge this block of data from its cache to make room for further receives.

Syntax

DWORD WDSTCIAPI WdsTransportClientCompleteReceive(
  [in] HANDLE          hSessionKey,
  [in] ULONG           ulSize,
  [in] PULARGE_INTEGER pullOffset
);

Parameters

[in] hSessionKey

Unique handle returned by the call to WdsTransportClientInitializeSession.

[in] ulSize

The size of the block being released.

[in] pullOffset

The offset of the block being released.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

Remarks

There must be one call to WdsTransportClientCompleteReceive for each call to the PFN_WdsTransportClientReceiveContents callback that the consumer receives. The length and offset parameters of this function call must match those provided in the receive contents callback. Failure to call this function will result in a stall in the multicast client once it hits the cache limit specified by the ulCacheSize of the WDS_TRANSPORTCLIENT_REQUEST structure passed to WdsTransportClientInitializeSession.

Requirements

Requirement	Value
Minimum supported client	Windows Vista with SP1 [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	wdstci.h
Library	Wdstptc.lib
DLL	Wdstptc.dll

Share via