CfGetPlaceholderInfo function (cfapi.h)

Gets various characteristics of a placeholder file or folder.


HRESULT CfGetPlaceholderInfo(
  [in]            HANDLE                    FileHandle,
  [in]            CF_PLACEHOLDER_INFO_CLASS InfoClass,
  [out]           PVOID                     InfoBuffer,
  [in]            DWORD                     InfoBufferLength,
  [out, optional] PDWORD                    ReturnedLength


[in] FileHandle

A handle to the placeholder whose information will be queried.

[in] InfoClass

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

[out] InfoBuffer

A pointer to a buffer that will receive information.

[in] InfoBufferLength

The length of the InfoBuffer, in bytes.

[out, optional] 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.


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