CfReferenceProtectedHandle function (cfapi.h)

Allows the caller to reference a protected handle to a Win32 handle which can be used with non-CfApi Win32 APIs.

Syntax

BOOLEAN CfReferenceProtectedHandle(
  [in] HANDLE ProtectedHandle
);

Parameters

[in] ProtectedHandle

The protected handle of a placeholder file.

Return value

If this function succeeds, it returns TRUE. Otherwise, it returns FALSE.

Remarks

Every CfReferenceProtectedHandle call must be matched with a CfReleaseProtectedHandle call. It is not recommended to reference a protected handle for a long period of time, as doing so will prevent the oplock break notification from being acknowledged.

The caller should instead break up long running tasks into smaller sub-tasks and reference/release the protected handle for each sub-task.

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 1709 [desktop apps only]
Minimum supported server	Windows Server 2016 [desktop apps only]
Target Platform	Windows
Header	cfapi.h
Library	CldApi.lib
DLL	CldApi.dll

See also

CfReleaseProtectedHandle