ConnectionValid Method (DataHelper)

Opens and closes the connection to ensure it is valid

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#
Managed Extensions for C++
C++/CLI

Public Overridable Function ConnectionValid() As String

Dim instance As DataHelper
Dim value As String
 
value = instance.ConnectionValid()

public virtual string ConnectionValid()

public: virtual string* ConnectionValid();

public:
virtual String^ ConnectionValid();

Return Value

Empty if valid or the error message

Example

//Get the current thread static safe instance of the helper
IDataHelper db = DataHelper.SessionFactory();
 
//Specify User Name and License Key from the receipt, leave blank for trial mode
//db.UserName = "John Smith 1234";
//db.LicenseKey = "asdfl219==";
 
//Log to the console
db.EnableLogging();
 
//This will be string.empty if valid or contain the error message
string result = db.ConnectionValid();
 
Console.WriteLine(result);

VB.NET

'Get the current thread static safe instance of the helper
Dim db As IDataHelper = DataHelper.SessionFactory()
 
'Specify User Name and License Key from the receipt, leave blank for trial mode
'db.UserName = "John Smith 1234"
'db.LicenseKey = "asdfl219=="
 
'Log to the console
db.EnableLogging()
 
'This will be string.empty if valid or contain the error message
Dim result As String = db.ConnectionValid()
 
Console.WriteLine(result)

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

DataHelper Class
DataHelper Members