PeerDistGetStatus function (peerdist.h)

The PeerDistGetStatus function returns the current status of the Peer Distribution service.

Syntax

DWORD PeerDistGetStatus(
  [in]  PEERDIST_INSTANCE_HANDLE hPeerDist,
  [out] PEERDIST_STATUS          *pPeerDistStatus
);

Parameters

[in] hPeerDist

A PEERDIST_INSTANCE_HANDLE returned by PeerDistStartup.

[out] pPeerDistStatus

A pointer to a PEERDIST_STATUS enumeration which upon operation success receives the current status of the Peer Distribution service.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

Remarks

A Group Policy change can result in the Peer Distribution service moving to an available, unavailable, or disabled state. Depending on the resultant state of this transition, the content, content information, or stream handles the caller has access to may no longer function. If this is the case, the caller must explicitly close the handles by calling the appropriate Peer Distribution API.

Requirements

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

See also

PEERDIST_STATUS

PeerDistClientCloseContent

PeerDistServerCloseContentInformation

PeerDistServerCloseStreamHandle