SugarParameter Class

In This Topic

Syntax
Remarks
Example
Inheritance Hierarchy
Requirements
See Also

Represents a parameter to a SugarCommand, and optionally, its mapping to System.Data.DataSet columns.

Syntax

Visual Basic
C#

public sealed class SugarParameter : Devart.Data.SqlShimParameter, System.Data.IDataParameter, System.Data.IDbDataParameter, System.ICloneable

'Declaration
 
Public NotInheritable Class SugarParameter 
   Inherits Devart.Data.SqlShimParameter
   Implements System.Data.IDataParameter, System.Data.IDbDataParameter, System.ICloneable

Remarks

Parameter names are not case-sensitive.

Refer to article Using Parameters in dotConnect for SugarCRM to obtain detailed information on the matter together with some advanced examples.

Example

The following example creates multiple instances of SugarParameter through the SugarParameterCollection within the SugarDataAdapter. These parameters are used to select data from SugarCRM and place the data in the System.Data.DataSet. This example assumes that a System.Data.DataSet and a SugarDataAdapter have already been created with the appropriate schema, commands, and connection.

csharp

public void AddSugarParameters()
{
  // ...
  // create myDataSet and myDataAdapter
  // ...
  myDataAdapter.SelectCommand.Parameters.Add("DName", SugarType.VarChar, 15).Value = "DEVELOPMENT";
  myDataAdapter.SelectCommand.Parameters.Add("DeptNo", SugarType.Int).Value = 50;
  myDataAdapter.Fill(myDataSet);
}

Visual Basic

Public Sub AddSugarParameters()
  ' ...
  ' create myDataSet and myDataAdapter
  ' ...
  myDataAdapter.SelectCommand.Parameters.Add("DName", SugarType.VarChar, 15).Value = "DEVELOPMENT"
  myDataAdapter.SelectCommand.Parameters.Add("DeptNo", SugarType.Int).Value = 50
  myDataAdapter.Fill(myDataSet)
End Sub

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      System.Data.Common.DbParameter
         Devart.Common.DbParameterBase
            Devart.Data.SqlShimParameter
               Devart.Data.Sugar.SugarParameter

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

SugarParameter Members
Devart.Data.Sugar Namespace
SugarCommand Class
SugarDataAdapter Class

Send Feedback