Share via


ID_PARAMETERS Structure

Represents the format schema for the group of IDs that are used to identify entities in a synchronization session.

typedef struct _ID_PARAMETERS
{
  DWORD dwSize
  ID_PARAMETER_PAIR replicaId;
  ID_PARAMETER_PAIR itemId;
  ID_PARAMETER_PAIR changeUnitId;
} ID_PARAMETERS;

Parameters

  • dwSize
    The number of bytes in the ID_PARAMETERS structure.
  • replicaId
    The ID format that is expected for replica IDs.
  • itemId
    The ID format that is expected for item IDs.
  • changeUnitId
    The ID format that is expected for change unit IDs.

Remarks

This structure is used when an IProviderSyncServices object is initialized to specify the format of each ID in the system. This ensures that all objects that are created by IProviderSyncServices have access to ID schema information.

This schema is also obtained after each attempt to create a synchronization session. To obtain ID parameters, both providers are queried through a call to ISyncProvider::GetIdParameters. These ID parameters are then compared to verify that both providers use the same ID schema. If this verification fails, the synchronization session is not created, and an error code is returned.

Requirements

Header: Synchronization.h

See Also

Reference

ID_PARAMETER_PAIR Structure
ISyncProvider::GetIdParameters
IProviderSyncServices::Initialize
IFeedSyncServices::Initialize

Concepts

Sync Framework Core Components
Flexible IDs