Tests the BargeExService to the BargeEx web services.

Namespace:  BargeEx
Assembly:  BargeEx (in BargeEx.dll)
Version: 3.0.400.140 (3.0.400.140)

Syntax

C#
public StandardReturnCode Test()
Visual Basic (Declaration)
Public Function Test As StandardReturnCode
Visual C++
public:
StandardReturnCode Test()

Return Value

A StandardReturnCode value that indicates whether or not the BargeEx web services could be reached.

Remarks

This method invokes the Test method available from the BargeEx web service. Any return value other than Success indicates a failure.

Examples

The following example creates a BargeExService object, initializes it, and calls the Test method.
CopyVisual Basic
' BargeEx Standard Return Code
Dim BargeExReturnCode As BargeEx.StandardReturnCode

' BargeExService object
Dim BargeExService As New BargeEx.BargeExService( _
   "https://www.BargeEx.com/Beta/BargeExService.asmx", _
   "12345678", _
   "UserName", _
   "Password")

' Test the connection
BargeExReturnCode = BargeExService.Test()
CopyC#
// BargeEx Standard Return Code
BargeEx.StandardReturnCode BargeExReturnCode;

// BargeExService object
BargeEx.BargeExService BargeExService = new BargeEx.BargeExService(
   "https://www.BargeEx.com/Beta/BargeExService.asmx", 
   "12345678", 
   "UserName", 
   "Password");

// Test the connection
BargeExReturnCode = BargeExService.Test();

See Also