Skip to main content
PeerDistClientOpenContent function

The PeerDistClientOpenContent function opens and returns a PEERDIST_CONTENT_HANDLE. The client uses the content handle to retrieve data from the Peer Distribution service.

Syntax


DWORD WINAPI PeerDistClientOpenContent(
  _In_      PEERDIST_INSTANCE_HANDLE hPeerDist,
  _In_      PCPEERDIST_CONTENT_TAG pContentTag,
  _In_opt_  HANDLE hCompletionPort,
  _In_opt_  ULONG_PTR ulCompletionKey,
  _Out_     PPEERDIST_CONTENT_HANDLE phContentHandle
);

Parameters

hPeerDist [in]

A PEERDIST_INSTANCE_HANDLE returned by PeerDistStartup.

pContentTag [in]

Pointer to a PEERDIST_CONTENT_TAG structure that contains a 16 byte client specified identifier. This parameter is used in conjunction with the PeerDistClientFlushContent function.

hCompletionPort [in, optional]

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.

ulCompletionKey [in, optional]

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

phContentHandle [out]

A pointer to a variable that receives the PEERDIST_CONTENT_HANDLE used to retrieve or add data.

Return value

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

Return codeDescription
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

Client must call the PeerDistClientOpenContent function to obtain a PEERDIST_CONTENT_HANDLE handle that later can be used in the following functions:

If an optional completion port handle is specified, it is used for posting the completion results of above listed asynchronous functions.

The handle returned by PeerDistClientOpenContent function call must be closed by PeerDistClientCloseContent function.

Requirements

Minimum supported client

Windows 7 Professional [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

PeerDist.h

Library

PeerDist.lib

DLL

PeerDist.dll

See also

PeerDistStartup
PeerDistClientAddContentInformation
PeerDistClientCompleteContentInformation
PeerDistClientBlockRead
PeerDistClientStreamRead
PeerDistClientAddData
PeerDistClientCloseContent
PeerDistClientFlushContent