CF_OPERATION_INFO structure (cfapi.h)

Information about an operation on a placeholder file or folder.

Syntax

typedef struct CF_OPERATION_INFO {
  ULONG                    StructSize;
  CF_OPERATION_TYPE        Type;
  CF_CONNECTION_KEY        ConnectionKey;
  CF_TRANSFER_KEY          TransferKey;
  const CORRELATION_VECTOR *CorrelationVector;
  const CF_SYNC_STATUS     *SyncStatus;
  CF_REQUEST_KEY           RequestKey;
} CF_OPERATION_INFO;

Members

StructSize

The size of the CF_OPERATION_INFO structure.

Type

The type of operation being performed. See CF_OPERATION_TYPE for more information.

ConnectionKey

A connection key obtained for the communication channel.

TransferKey

An opaque handle to the placeholder.

CorrelationVector

A correlation vector on a placeholder used for telemetry purposes.

SyncStatus

Note

This member is new for Windows 10, version 1803.

The current CF_SYNC_STATUS of the platform.

The platform queries this information upon any failed operations on a cloud file placeholder. If a structure is available, the platform will use the information provided to construct a more meaningful and actionable message to the user. The platform will keep this information on the file until the last handle on it goes away. If SyncStatus is null, the platform will clear the previously set sync status, if there is one.

RequestKey

An opaque id that uniquely identifies a cloud file operation on a particular cloud file.

Remarks

The platform provides the ConnectionKey, TransferKey, and CorrelationVector to all callback functions registered via CfConnectSyncRoot. Additionally, sync providers can obtain a TransferKey using CfGetTransferKey and a CorrelationVector using CfGetCorrelationVector.

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_OPERATION_TYPE

CfConnectSyncRoot

CfGetTransferKey

CfGetCorrelationVector

CfExecute

CF_SYNC_STATUS