Datasnap.DSClientRest.TDSCustomRestConnection.TestConnection

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type:
procedure
function
Visibility: public
Source:
Datasnap.DSClientRest.pas
Datasnap.DSClientRest.hpp
Unit: Datasnap.DSClientRest
Parent: TDSCustomRestConnection

Delphi

procedure TestConnection(AOptions: TDSTestConnectionOptions = []);

C++

void __fastcall TestConnection(TDSTestConnectionOptions AOptions = TDSTestConnectionOptions() );

Description

Tests to see whether the REST connection can be made.

Call the TestConnection method to verify whether the REST connection can be made or not. If the connection cannot be completed, an exception is raised.

The AOptions parameter holds a set of test connection options.