Edit

PeerDistShutdown function (peerdist.h)

  • Article

The PeerDistShutdown function releases resources allocated by a call to PeerDistStartup. Each handle returned by a PeerDistStartup call must be closed by a matching call to PeerDistShutdown

Syntax

DWORD PeerDistShutdown(
  [in] PEERDIST_INSTANCE_HANDLE hPeerDist
);

Parameters

[in] hPeerDist

A PEERDIST_INSTANCE_HANDLE returned by PeerDistStartup.

Return value

If the function succeeds, the return value is ERROR_SUCCESS. Otherwise, the function may return one of the following values:

Return code Description
ERROR_INVALID_HANDLE
 The hPeerDist handle is invalid.

Remarks

This function will remove all publications that were created with the specified hPeerDist handle. It is recommended that this function is called after all pending operations have completed, as PeerDistShutdown cancel all pending Peer Distribution client and server operations associated with the supplied PEERDIST_INSTANCE_HANDLE.

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

PeerDistStartup