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

hSessionKey [in]

Unique handle returned by the call to WdsTransportClientInitializeSession.

puStatus [out]

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.

 

puErrorCode [out]

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

Send comments about this topic to Microsoft

Build date: 12/11/2009