Edit

Share via

WdsTransportClientInitializeSession function (wdstci.h)

  • Article

Initiates a multicast file transfer.

Syntax

DWORD WDSTCIAPI WdsTransportClientInitializeSession(
  [in]  PWDS_TRANSPORTCLIENT_REQUEST pSessionRequest,
  [in]  PVOID                        pCallerData,
  [out] PHANDLE                      hSessionKey
);

Parameters

[in] pSessionRequest

Pointer to a WDS_TRANSPORTCLIENT_REQUEST structure that contains all the details required to initiate the multicast session. The format of this structure is described below.

[in] pCallerData

User supplied pointer that will be provided with every callback for this session.

[out] hSessionKey

Buffer that will receive the address of a handle that the consumer can use to uniquely identify this session to the client.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

Remarks

This function only sets up the session, it does not start the transfer. To start the transfer, call WdsTransportClientStartSession.

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