CfGetPlaceholderStateFromFileInfo function (cfapi.h)

Article
02/22/2024

Gets a set of placeholder states based on the various information of the file.

Syntax

CF_PLACEHOLDER_STATE CfGetPlaceholderStateFromFileInfo(
  [in] LPCVOID                   InfoBuffer,
  [in] FILE_INFO_BY_HANDLE_CLASS InfoClass
);

Parameters

[in] InfoBuffer

An info buffer about the file.

[in] InfoClass

An info class so the function knows how to interpret the InfoBuffer.

Return value

Can include CF_PLACEHOLDER_STATE; the placeholder state.

Remarks

The input is a buffer containing information returned by GetFileInformationByHandleEx, and the corresponding InfoClass so the API knows how to interpret the buffer.

Not all information classes supported by GetFileInformationByHandleEx are supported by this API. If the FileAttributes and ReparseTag can’t be extracted from a given information class, this API will return CF_PLACEHOLDER_STATE_INVALID and set last error properly.

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