Edit

WdsTransportClientRegisterCallback function (wdstci.h)

  • Article

Registers a callback with the multicast client.

Syntax

DWORD WDSTCIAPI WdsTransportClientRegisterCallback(
  [in] HANDLE                      hSessionKey,
  [in] TRANSPORTCLIENT_CALLBACK_ID CallbackId,
  [in] PVOID                       pfnCallback
);

Parameters

[in] hSessionKey

Unique handle returned by the call to WdsTransportClientInitializeSession.

[in] CallbackId

Identifier specifying which callback is being registered. This parameter receives a TRANSPORTCLIENT_CALLBACK_ID enumeration value.

Value Meaning
WDS_TRANSPORTCLIENT_SESSION_START
 Identifies the PFN_WdsTransportClientSessionStart callback. This callback is required.
WDS_TRANSPORTCLIENT_RECEIVE_CONTENTS
 Identifies the PFN_WdsTransportClientReceiveContents callback. This callback is required.
WDS_TRANSPORTCLIENT_SESSION_COMPLETE
 Identifies the PFN_WdsTransportClientSessionComplete callback. This callback is required.
WDS_TRANSPORTCLIENT_RECEIVE_METADATA
 Identifies the PFN_WdsTransportClientReceiveMetadata callback. This callback is optional.

[in] pfnCallback

Pointer to the function pointer associated with this id.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

Remarks

All callbacks must be registered with the client before the consumer calls WdsTransportClientStartSession. Once the session is started, no further callbacks may be registered.

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