DataSetSurrogate Class

Article
10/22/2010

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

Inheritance Hierarchy

System.Object
Microsoft.Synchronization.Data.DataSetSurrogate

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

Syntax

'Declaration
<SerializableAttribute> _
Public Class DataSetSurrogate _
    Implements IDisposable
'Usage
Dim instance As DataSetSurrogate

[SerializableAttribute]
public class DataSetSurrogate : IDisposable

[SerializableAttribute]
public ref class DataSetSurrogate : IDisposable

[<SerializableAttribute>]
type DataSetSurrogate =  
    class
        interface IDisposable
    end

public class DataSetSurrogate implements IDisposable

The DataSetSurrogate type exposes the following members.

Constructors

	Name	Description
	DataSetSurrogate	Initializes a new instance of the DataSetSurrogate class.

Top

Properties

	Name	Description
	DatasetName	Gets or sets the name of the data set that the DataSetSurrogate object represents.
	Locale	Gets or sets the locale information used to compare strings within the table.

Top

Methods

	Name	Description
	ConvertToDataSet	Constructs a DataSet object based on a DataSetSurrogate object.
	Dispose()	Releases all resources used by the DataSetSurrogate.
	Dispose(Boolean)	Releases the unmanaged resources used by the DataSetSurrogate and optionally releases the managed resources.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetDataTableSurrogates	Gets an array of DataTableSurrogate objects that comprise the data set that is represented by the DataSetSurrogate object.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	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.

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.