CF_PLACEHOLDER_CREATE_INFO structure (cfapi.h)

Contains placeholder information for creating new placeholder files or directories.

Syntax

typedef struct CF_PLACEHOLDER_CREATE_INFO {
  LPCWSTR                     RelativeFileName;
  CF_FS_METADATA              FsMetadata;
  LPCVOID                     FileIdentity;
  DWORD                       FileIdentityLength;
  CF_PLACEHOLDER_CREATE_FLAGS Flags;
  HRESULT                     Result;
  USN                         CreateUsn;
} CF_PLACEHOLDER_CREATE_INFO;

Members

RelativeFileName

The name of the child placeholder file or directory to be created. It should consist only of the file or directory name.

For example, if the sync root of the provider is C:\SyncRoot then to create a placeholder named placeholder.txt in a subdirectory SubDirectory of the sync root, call the CfCreatePlaceholders function with BaseDirectoryPath equal to C:\SyncRoot\SubDirectory and set the RelativePathName field of the CF_PLACEHOLDER_CREATE_INFO to placeholder.txt.

FsMetadata

File system metadata to be created with the placeholder.

FileIdentity

A user mode buffer containing file information supplied by the sync provider. This is required for files (not for directories).

FileIdentityLength

Length, in bytes, of the FileIdentity.

Flags

Flags for specifying placeholder creation behavior.

Result

The result of placeholder creation. On successful creation, the value is: STATUS_OK.

CreateUsn

The final USN value after create actions are performed.

Requirements

   
Minimum supported client Windows 10, version 1709 [desktop apps only]
Minimum supported server Windows Server 2016 [desktop apps only]
Header cfapi.h