FhServiceClosePipe function (fhsvcctl.h)

Article
02/22/2024

Closes a communication channel to the File History Service opened with FhServiceOpenPipe.

Note

FhServiceClosePipe is deprecated and may be altered or unavailable in future releases.

Syntax

HRESULT FhServiceClosePipe(
  [in] FH_SERVICE_PIPE_HANDLE Pipe
);

Parameters

[in] Pipe

The communication channel handle returned by an earlier FhServiceOpenPipe call.

Return value

S_OK on success, or an unsuccessful HRESULT value on failure. Possible unsuccessful HRESULT values include values defined in the FhErrors.h header file.

Remarks

An application should call FhServiceClosePipe once for each communication channel handle it opens with FhServiceOpenPipe. Closing a communication channel handle multiple times is not supported and may lead to unpredictable behavior.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	fhsvcctl.h
Library	FhSvcCtl.lib