SqlCeException.Message Property

Gets the text describing the first instance of SqlCeError in the SqlCeErrorCollection for this exception.

Namespace:  System.Data.SqlServerCe
Assembly:  System.Data.SqlServerCe (in System.Data.SqlServerCe.dll)

Syntax

'Declaration
Public Overrides ReadOnly Property Message As String
    Get
'Usage
Dim instance As SqlCeException
Dim value As String

value = instance.Message

public override string Message { get; }

public:
virtual property String^ Message {
    String^ get () override;
}

abstract Message : string
override Message : string

override function get Message () : String

Property Value

Type: System.String
The text describing the error.

Implements

_Exception.Message

Remarks

This is the same as the Message property of the first instance of SqlCeError in the SqlCeErrorCollection for this exception.

Examples

The following example displays the Message and NativeError properties of the first SqlCeError within the SqlCeErrorCollection collection.

Try
    Dim repl As New SqlCeReplication()

    ' Fill repl properites here
    ' ...
    ' SqlCeReplication may throw SqlCeException which contains a 
    ' collection of errors; SQL Mobile database engine always
    ' returns one error in the collection
    '
    repl.Synchronize()
Catch e As SqlCeException
    Dim err As SqlCeError
    For Each err In e.Errors
        ' Use SqlCeError properties if you need specific
        ' application logic depending on the error condition
        '
        If 28577 = [err].NativeError Then 'SSCE_M_SCHEMAHASCHANGED
            ' Error specific logic goes here...
            '
        End If

        ' Note: For native error numbers, refer to SQL Server Mobile Errors
        ' in the SQL Server Mobile Books Online
        '
        MessageBox.Show([err].Message)
    Next err
End Try

try
{
    SqlCeReplication repl = new SqlCeReplication();

    // Fill repl properites here
    // ...

    // SqlCeReplication may throw SqlCeException which contains a 
    // collection of errors; SQL Mobile database engine always
    // returns one error in the collection
    //
    repl.Synchronize();
}
catch (SqlCeException e)
{
    foreach (SqlCeError error in e.Errors)
    {
        // Use SqlCeError properties if you need specific
        // application logic depending on the error condition
        //
        if (28577 == error.NativeError /*SSCE_M_SCHEMAHASCHANGED*/)
        {
            // Error specific logic goes here...
            //
        }

        // Note: For native error numbers, refer to SQL Server Mobile Errors
        // in the SQL Server Mobile Books Online
        //
        MessageBox.Show(error.Message);
    }
}

See Also

Reference

SqlCeException Class

System.Data.SqlServerCe Namespace