SqlCeReplication.ProfileName Property

Article
10/22/2009

Specifies the name of the agent profile at the Distributor to be used by the SqlCeReplication object.

Namespace: System.Data.SqlServerCe
Assembly: System.Data.SqlServerCe (in system.data.sqlserverce.dll)

Syntax

'Declaration
Public Property ProfileName As String

public string ProfileName { get; set; }

public:
property String^ ProfileName {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_ProfileName ()

/** @property */
public void set_ProfileName (String value)

public function get ProfileName () : String

public function set ProfileName (value : String)

Property Value

The agent profile name.

Remarks

A profile defines behavior, such as time-out values. You can override the default values by creating a profile on the Distributor and specifying its name through the ProfileName property.

A profile contains a set of parameters that control the behavior of the SQL Server Reconciler. For example, the profile specifies the LoginTimeout and QueryTimeout values used by the SQL Server Reconciler. The profile is stored on the Distributor. The profile is read each time a subscription is synchronized. For more information, see "Agent Profiles" in SQL Server Books Online.

The profile allows you to easily change key parameters for synchronization. For example, if you have five SQL Server Compact 3.5 SP1 clients who share a profile and you want to change the query time-out value, you change the QueryTimeout value in the profile and all SQL Server Compact 3.5 SP1 clients will use the new QueryTimeout value.

You can also create different profiles for different SQL Server Compact 3.5 SP1 clients. For example, a SQL Server Compact 3.5 SP1 client that uses a dial-up Internet connection might use one time-out value while a client that uses a high-speed intranet connection might use a different time-out value. The ProfileName property is used to specify the name of the profile.

If the ProfileName property is not specified, the default profile values are used.

Thread Safety

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

Platforms

Development Platforms

Windows Vista, Windows Mobile 5.0, Windows XP Professional with Service Pack 2 (SP2), Windows Server 2003, Windows Mobile 2003 for Pocket PC, Windows CE 5.0
Version Information
.NET Framework and NET Compact Framework
Supported in 3.5
.NET Framework
Supported in 3.0
.NET Compact Framework and .Net Framework
Supported in 2.0