SyncId Class

  • Article

Represents an identifier for an item, change unit, or replica.

Inheritance Hierarchy

System.Object
  Microsoft.Synchronization.SyncId

Namespace:  Microsoft.Synchronization
Assembly:  Microsoft.Synchronization (in Microsoft.Synchronization.dll)

Syntax

'Declaration
<SerializableAttribute> _
Public Class SyncId _
    Implements IComparable, IEquatable(Of SyncId),  _
    ISerializable
'Usage
Dim instance As SyncId

[SerializableAttribute]
public class SyncId : IComparable, IEquatable<SyncId>, 
    ISerializable

[SerializableAttribute]
public ref class SyncId : IComparable, IEquatable<SyncId^>, 
    ISerializable

[<SerializableAttribute>]
type SyncId =  
    class
        interface IComparable
        interface IEquatable<SyncId>
        interface ISerializable
    end

public class SyncId implements IComparable, IEquatable<SyncId>, ISerializable

The SyncId type exposes the following members.

Constructors

  Name Description
Public method SyncId(Byte) Initializes a new instance of the SyncId class that contains the specified ID.
Public method SyncId(Guid) Initializes a new instance of the SyncId class that contains the specified GUID.
Public method SyncId(String) Initializes a new instance of the SyncId class that contains the specified ID.
Public method SyncId(SyncGlobalId) Initializes a new instance of the SyncId class that contains the specified global ID.
Public method SyncId(Byte[], Boolean) Initializes a new instance of the SyncId class that contains the specified raw ID and a value that indicates whether the ID is fixed length or variable length.
Protected method SyncId(SerializationInfo, StreamingContext) Initializes a new instance of the SyncId class by using serialized data.

Top

Properties

  Name Description
Public property IsVariableLength Gets a value that indicates whether the ID is variable length.
Public property RawId Gets the raw ID data in a byte array.

Top

Methods

  Name Description
Public method CompareTo Compares this object with another SyncId object.
Public method Equals(Object) Determines whether the specified SyncId object is equal to this object. (Overrides Object.Equals(Object).)
Public method Equals(SyncId) Determines whether the specified SyncId object is equal to this object.
Protected method Finalize (Inherited from Object.)
Public method GetByteId Gets a 1-byte sync ID.
Public method GetGuidId Gets a GUID sync ID.
Public method GetHashCode Computes a hash code suitable for use in hashing algorithms and data structures, such as a hash table. (Overrides Object.GetHashCode().)
Public method GetObjectData Serializes the object data to the specified SerializationInfo object.
Public method GetStringId Gets a string sync ID.
Public method GetSyncGlobalId Gets a SyncGlobalId sync ID.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString Returns a string that represents the sync ID. (Overrides Object.ToString().)

Top

Operators

  Name Description
Public operatorStatic member Equality Determines whether the two specified SyncId objects are equal.
Public operatorStatic member GreaterThan Determines whether idX is greater than idY.
Public operatorStatic member Inequality Determines whether the two specified SyncId objects are not equal.
Public operatorStatic member LessThan Determines whether idX is less than idY.

Top

Remarks

The ID length must be greater than 0 and no greater than UInt16.MaxValue.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Synchronization Namespace