Edit

FhServiceOpenPipe function (fhsvcctl.h)

  • Article

Opens a communication channel to the File History Service.

Note

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

Syntax

HRESULT FhServiceOpenPipe(
  [in]  BOOL                   StartServiceIfStopped,
  [out] FH_SERVICE_PIPE_HANDLE *Pipe
);

Parameters

[in] StartServiceIfStopped

If the File History Service is not started yet and this parameter is TRUE, this function starts the File History Service before opening a communication channel to it.

If the File History Service is not started yet and this parameter is FALSE, this function fails and returns an unsuccessful HRESULT value.

[out] Pipe

On successful return, this parameter contains a non-NULL handle representing a newly opened communication channel to the File History Service.

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.

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

See also

FhServiceClosePipe