Edit

CF_PLACEHOLDER_BASIC_INFO structure (cfapi.h)

  • Article

Basic placeholder information.

Syntax

typedef struct CF_PLACEHOLDER_BASIC_INFO {
  CF_PIN_STATE     PinState;
  CF_IN_SYNC_STATE InSyncState;
  LARGE_INTEGER    FileId;
  LARGE_INTEGER    SyncRootFileId;
  ULONG            FileIdentityLength;
  BYTE             FileIdentity[1];
} CF_PLACEHOLDER_BASIC_INFO;

Members

PinState

The CF_PIN_STATE of the placeholder, which is used to represent a user’s intent. See CfSetPinState for more details.

InSyncState

The CF_IN_SYNC_STATE of the placeholder. See CfSetInSyncState for more details.

FileId

A 64-bit volume wide non-volatile number that uniquely identifies a file or directory.

SyncRootFileId

The file ID of the sync root directory that contains the file whose placeholder information is to be queried.

FileIdentityLength

Length, in bytes, of the FileIdentity.

FileIdentity[1]

An opaque blob supplied by the sync provider to the platform when the placeholder was created. File identity is provided for all sync provider callbacks.

Requirements

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

See also

CF_PIN_STATE

CfSetPinState

CF_IN_SYNC_STATE

CfSetInSyncState