PeerDistClientGetInformationByHandle function (peerdist.h)

The PeerDistClientGetInformationByHandle function retrieves additional information from the Peer Distribution service for a specific content handle.

Syntax

DWORD PeerDistClientGetInformationByHandle(
  [in]  PEERDIST_INSTANCE_HANDLE             hPeerDist,
  [in]  PEERDIST_CONTENT_HANDLE              hContentHandle,
  [in]  PEERDIST_CLIENT_INFO_BY_HANDLE_CLASS PeerDistClientInfoClass,
        DWORD                                dwBufferSize,
  [out] LPVOID                               lpInformation
);

Parameters

[in] hPeerDist

A PEERDIST_INSTANCE_HANDLE returned by the PeerDistStartup function.

[in] hContentHandle

A PEERDIST_CONTENT_HANDLE returned by the PeerDistClientOpenContent function.

[in] PeerDistClientInfoClass

A value from the PEERDIST_CLIENT_INFO_BY_HANDLE_CLASS enumeration that indicates the information to retrieve.

dwBufferSize

The size, in bytes, of the buffer for the lpInformation parameter.

[out] lpInformation

A buffer for the returned information. The format of this information depends on the value of the PeerDistClientInfoClass parameter.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header peerdist.h
Library PeerDist.lib
DLL PeerDist.dll

See also

PEERDIST_CLIENT_INFO_BY_HANDLE_CLASS

PeerDistClientOpenContent

PeerDistStartup