CF_SYNC_REGISTRATION 構造体 (cfapi.h)

  • [アーティクル]

登録する同期プロバイダーと同期ルートの詳細。

構文

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

メンバー

StructSize

CF_SYNC_REGISTRATION構造体のサイズ。

ProviderName

同期プロバイダーの名前。 これは、最大 255 文字のユーザー フレンドリな文字列です。

ProviderVersion

同期プロバイダーのバージョン。 これは、最大 255 文字のユーザー フレンドリな文字列です。

SyncRootIdentity

プロバイダーによって使用される同期ルート ID。 このメンバーは省略可能で、最大サイズは 64 KB です。 最大長を超えると 、API は ERROR_INVALID_PARAMETER で失敗します。 プラットフォームは、同期プロバイダーへのコールバックで SyncRootIdentity を同期プロバイダーに返します。

SyncRootIdentityLength

SyncRootIdentity の長さ。 このメンバーは省略可能であり、 SyncRootIdentity が指定されている場合にのみ使用されます。

FileIdentity

省略可能なファイル ID。 このメンバーの最大サイズは 4 KB です。 最大長を超えると 、API は ERROR_INVALID_PARAMETER で失敗します。 同期ルート FileIdentity BLOB は、コールバックのサブジェクトが同期ルート自体である場合にのみ提供されます。

FileIdentityLength

FileIdentity の長さ。 このメンバーは省略可能であり、 FileIdentity が指定されている場合にのみ使用されます。

ProviderId

これは、特定の同期プロバイダーを識別するための GUID です。 これはオプションです。 指定しない場合、プラットフォームは ProviderName 文字列の MD5 ハッシュを使用して GUID を生成します。 この情報は、同期プロバイダーが異なる ProviderName 文字列を使用して同期ルートを登録する場合でも、同じ同期プロバイダーからのアクティビティをより効率的かつ正確に関連付けることができるよう、テレメトリにのみ使用されます。 同期プロバイダーは、同期製品のすべてのバージョンに対して常に同じ GUID を指定することをお勧めします。 一方、同期プロバイダーは、最適なユーザー エクスペリエンスのために、さまざまな ProviderName 文字列を自由に選択できます。

注釈

SyncRootIdentity と SyncRootIdentityLength は省略可能なメンバーです。 使用しない場合は、 SyncRootIdentity を に nullptr 設定し、 SyncRootIdentityLength を に 0設定します。 FileIdentity と FileIdentityLength も省略可能であり、使用しない場合は、 と 0にそれぞれ設定するnullptr必要があります。

要件

要件 値
サポートされている最小のクライアント Windows 10バージョン 1709 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2016 [デスクトップ アプリのみ]
Header cfapi.h

こちらもご覧ください

CfRegisterSyncRoot