Share via


DataTableSurrogate Class

Represents a surrogate of a DataTable object, which Sync Framework uses during custom binary serialization.

Inheritance Hierarchy

System.Object
  Microsoft.Synchronization.Data.DataTableSurrogate

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

Syntax

'Declaration
<SerializableAttribute> _
Public Class DataTableSurrogate _
    Implements IDisposable
'Usage
Dim instance As DataTableSurrogate
[SerializableAttribute]
public class DataTableSurrogate : IDisposable
[SerializableAttribute]
public ref class DataTableSurrogate : IDisposable
[<SerializableAttribute>]
type DataTableSurrogate =  
    class
        interface IDisposable
    end
public class DataTableSurrogate implements IDisposable

The DataTableSurrogate type exposes the following members.

Constructors

  Name Description
Public method DataTableSurrogate Initializes a new instance of the DataTableSurrogate class.

Top

Properties

  Name Description
Public property Locale Gets or sets the locale information used to compare strings within the table.
Public property MinimumCapacity Gets or sets the initial starting size for this table.
Public property RowStates Gets or sets an array that represents the state of each row in the table.
Public property TableName Gets or sets the name of the table that the DataTableSurrogate object represents.

Top

Methods

  Name Description
Public method Dispose() Releases all resources used by the DataTableSurrogate.
Protected method Dispose(Boolean) Releases the unmanaged resources used by the DataTableSurrogate and optionally releases the managed resources.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetDataColumnSurrogates Gets an array of DataColumnSurrogate objects that comprise the table that is represented by the DataTableSurrogate object.
Public method GetHashCode (Inherited from Object.)
Public method GetRecords Gets an array of objects that represent the columns and rows of data in the DataTableSurrogate object.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ReadDataIntoDataTable Copies the table schema from a DataTableSurrogate object into a DataTable object.
Public method ReadSchemaIntoDataTable Copies the table data from a DataTableSurrogate object into a DataTable object.
Public method ToString (Inherited from Object.)

Top

Remarks

This surrogate does not retain all of the properties of the object on which it is based. The only properties it retains are those that are publicly exposed. For example, this surrogate does not retain the original values for rows that were updated or deleted.

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.Data Namespace