PeerDistClientFlushContent function (peerdist.h)

Article
10/13/2021

Syntax

DWORD PeerDistClientFlushContent(
  [in]           PEERDIST_INSTANCE_HANDLE hPeerDist,
  [in]           PCPEERDIST_CONTENT_TAG   pContentTag,
  [in, optional] HANDLE                   hCompletionPort,
  [in, optional] ULONG_PTR                ulCompletionKey,
  [in]           LPOVERLAPPED             lpOverlapped
);

Parameters

[in] hPeerDist

A PEERDIST_INSTANCE_HANDLE returned by PeerDistStartup.

[in] pContentTag

Pointer to a PEERDIST_CONTENT_TAG structure that contains the tag supplied when PeerDistClientOpenContent is called.

[in, optional] hCompletionPort

A handle to the completion port that can be used for retrieving the completion notification of the asynchronous function. To create a completion port, use the CreateIoCompletionPort function. This parameter can be NULL.

[in, optional] ulCompletionKey

Value to be returned through the lpCompletionKey parameter of the GetQueuedCompletionStatus function. This parameter is ignored when hCompletionPort is NULL.

[in] lpOverlapped

Pointer to an OVERLAPPED structure. Offset and OffsetHigh are reserved and must be zero.

Return value

If the function succeeds, the return value is ERROR_IO_PENDING. 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 handle is invalid.
ERROR_ACCESS_DISABLED_BY_POLICY	The feature is disabled by Group Policy.
PEERDIST_ERROR_SERVICE_UNAVAILABLE	The service is unavailable.

Remarks

The pContentTag is a client supplied tag passed to PeerDistClientOpenContent, which labels the content added by the client. This tag is used by the API to selectively flush content from the Peer Distribution cache.

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