CfGetPlaceholderInfo function

Gets various characteristics of a placeholder file or folder.

Syntax

HRESULT CfGetPlaceholderInfo(
  HANDLE                    FileHandle,
  CF_PLACEHOLDER_INFO_CLASS InfoClass,
  PVOID                     InfoBuffer,
  DWORD                     InfoBufferLength,
  PDWORD                    ReturnedLength
);

Parameters

FileHandle

A handle to the placeholder whose information will be queried.

InfoClass

Placeholder information. This can be set to either CF_PLACEHOLDER_STANDARD_INFO or CF_PLACEHOLDER_BASIC_INFO.

InfoBuffer

A pointer to a buffer that will receive information.

InfoBufferLength

The length of the InfoBuffer, in bytes.

ReturnedLength

The number of bytes returned in the InfoBuffer.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

   
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