SqlCeParameterCollection.Add Method (String, Object)

2009-10-22

Adds a SqlCeParameter to the SqlCeParameterCollection given the parameter name and value.

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

Syntax

'Declaration
Public Function Add ( _
    parameterName As String, _
    value As Object _
) As SqlCeParameter

public SqlCeParameter Add (
    string parameterName,
    Object value
)

public:
SqlCeParameter^ Add (
    String^ parameterName, 
    Object^ value
)

public SqlCeParameter Add (
    String parameterName, 
    Object value
)

public function Add (
    parameterName : String, 
    value : Object
) : SqlCeParameter

Parameters

parameterName
The name of the parameter.

value
The Object value of the SqlCeParameter to add to the collection.

Return Value

A reference to the new SqlCeParameter object.

Exceptions

Exception type	Condition
InvalidCastException	The object supplied as the value parameter cannot be converted to a string. This can happen if the object is not a primitive type, SqlDbType or byte array.

Remarks

The SqlDbType of the new SqlCeParameter object is not inferred from the type of the value parameter. The Value property of the new SqlCeParameter object is set to the string obtained from converting value parameter and the SqlDbType is set to SqlDbType.NChar.

If you want to explicitly set the SqlDbType of the parameter when it is created, you should use one of the other overloaded Add methods.

Example

The following example adds new element to a SqlCeParameterCollection. It assumes that a SqlCeCommand has already been created.

cmd.Parameters.Add("@Description", "Beverages")

cmd.Parameters.Add("@Description", "Beverages");

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

Share via