WdsTransportClientCompleteReceive function

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_ HANDLE          ulSize,
  _In_ PULARGE_INTEGER pullOffset
);

Parameters

hSessionKey [in]

Unique handle returned by the call to WdsTransportClientInitializeSession.

ulSize [in]

The size of the block being released.

pullOffset [in]

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

Minimum supported client

Windows Vista with SP1 [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Wdstci.h

Library

Wdstptc.lib

DLL

Wdstptc.dll

 

 

Community Additions

ADD
Show: