Edit

PeerDistServerCloseStreamHandle function (peerdist.h)

  • Article

The PeerDistServerCloseStreamHandle function closes a handle returned by PeerDistServerPublishStream.

Syntax

DWORD PeerDistServerCloseStreamHandle(
  [in] PEERDIST_INSTANCE_HANDLE hPeerDist,
  [in] PEERDIST_STREAM_HANDLE   hStream
);

Parameters

[in] hPeerDist

A PEERDIST_INSTANCE_HANDLE returned by PeerDistStartup.

[in] hStream

A PEERDIST_STREAM_HANDLE returned by PeerDistServerPublishStream.

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_PARAMETER
 One or more parameters are invalid.
ERROR_INVALID_HANDLE
 The hPeerDist or hStream handle is invalid

Remarks

The PeerDistServerCloseStreamHandle function call cancels all pending operations associated with hStream. To prevent unintended cancellation of publication and closure of the stream handle, this function should be called after the completion of PeerDistServerPublishCompleteStream.

PeerDistServerCloseStreamHandle does not remove the publication. In order to remove the publication, call PeerDistServerUnpublish.

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

PeerDistServerPublishCompleteStream

PeerDistServerPublishStream

PeerDistServerUnpublish