Edit

Share via

WdsTransportClientQueryStatus function (wdstci.h)

  • Article

Retrieves the current status of an ongoing or complete multicast transmission from the multicast client.

Syntax

DWORD WDSTCIAPI WdsTransportClientQueryStatus(
  [in]  HANDLE hSessionKey,
  [out] PULONG puStatus,
  [out] PULONG puErrorCode
);

Parameters

[in] hSessionKey

Unique handle returned by the call to WdsTransportClientInitializeSession.

[out] puStatus

The current status of the transfer. This can be one of the following values.

Value Meaning
WDS_TRANSPORTCLIENT_STATUS_IN_PROGRESS
 The multicast session is still in progress.
WDS_TRANSPORTCLIENT_STATUS_SUCCESS
 The multicast session completed successfully.
WDS_TRANSPORTCLIENT_STATUS_FAILURE
 The multicast session failed.

[out] puErrorCode

If puStatus is set to WDS_TRANSPORTCLIENT_STATUS_FAILURE, this field will be set to the error code of the session.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

Remarks

It is valid to call this function even after a transfer completes as long as the session key has not been closed.

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