adTempus API
ArcanaDevelopment.adTempus.Client Namespace / Scheduler Class / TestDatabaseConnection Method
The ArcanaDevelopment.adTempus.Shared.DatabaseConnectionSettings defining the connection to test.


In This Topic
    TestDatabaseConnection Method
    In This Topic
    Tests a database connection defined for a DatabaseOperationTask
    Syntax
    'Declaration
     
    
    <NotNullAttribute()>
    Public Function TestDatabaseConnection( _
       ByVal settings As DatabaseConnectionSettings _
    ) As MessageCollection
    [NotNull()]
    public MessageCollection TestDatabaseConnection( 
       DatabaseConnectionSettings settings
    )
    [NotNull()]
    public:
    MessageCollection^ TestDatabaseConnection( 
       DatabaseConnectionSettings^ settings
    ) 

    Parameters

    settings
    The ArcanaDevelopment.adTempus.Shared.DatabaseConnectionSettings defining the connection to test.

    Return Value

    A collection of messages indicating the results of the test.
    Remarks
    This method tests whether adTempus can connect to the database using the settings given.
    See Also