SqlCeParameterCollection.Add Method (String, Object)

Article
10/22/2007

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
'Usage
Dim instance As SqlCeParameterCollection
Dim parameterName As String
Dim value As Object
Dim returnValue As SqlCeParameter

returnValue = instance.Add(parameterName, value)

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 .NET Compact Framework 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");

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see .

Platforms

Windows CE, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows XP Professional x64 Edition, Windows XP SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Version Information

.NET Compact Framework

Supported in: 2.0, 1.0

Share via