CF_SYNC_REGISTRATION structure (cfapi.h)

The details of the sync provider and sync root to be registered.

Syntax

typedef struct CF_SYNC_REGISTRATION {
  ULONG   StructSize;
  LPCWSTR ProviderName;
  LPCWSTR ProviderVersion;
  LPCVOID SyncRootIdentity;
  DWORD   SyncRootIdentityLength;
  LPCVOID FileIdentity;
  DWORD   FileIdentityLength;
  GUID    ProviderId;
} CF_SYNC_REGISTRATION;

Members

StructSize

The size of the structure.

ProviderName

The name of the sync provider. This is a user friendly string with a maximum length of 255 characters.

ProviderVersion

The version of the sync provider. This is a user friendly string with a maximum length of 255 characters.

SyncRootIdentity

The sync root identity used by the provider. This member is optional with a maximum size of 64 KB.

SyncRootIdentityLength

The length of the SyncRootIdentity. This member is optional and is only used if a SyncRootIdentity is provided.

FileIdentity

An optional file identity. This member has a maximum size of 4 KB.

FileIdentityLength

The length of the file identity.

ProviderId

Remarks

SyncRootIdentity and SyncRootIdentityLength are optional members. If not used, set SyncRootIdentity to nullptr and SyncRootIdentityLength to 0. FileIdentity and FileIdentityLength are also optional and if not used should be set to nullptr and 0, respectively.

Requirements

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