EMS.Services.TEMSInternalAPI.DeleteInstallation

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: function
Visibility: public
Source:
EMS.Services.pas
EMS.Services.hpp
Unit: EMS.Services
Parent: TEMSInternalAPI

Delphi

function DeleteInstallation(const AInstallationID: string; out AResponse: IEMSResourceResponseContent): Boolean; overload;
function DeleteInstallation(const AInstallationID: string): Boolean; overload;

C++

bool __fastcall DeleteInstallation(const System::UnicodeString AInstallationID, /* out */ _di_IEMSResourceResponseContent &AResponse)/* overload */;
bool __fastcall DeleteInstallation(const System::UnicodeString AInstallationID)/* overload */;

Description

Deletes an existing EMS Installation from the EMS Server.

The DeleteInstallation executes the delete request from the EMS Server for the AInstallationID.

The DeleteInstallation method is overloaded:

  • The first overloaded method receives the AInstallationID to execute the delete request, and uses the AResponse to return the response from the EMS Server.
  • The second overloaded method receives the AInstallationID to execute the delete request.

DeleteInstallation returns False if the response request status code is 404 (the EMS Installation is Not found). Otherwise, DeleteInstallation returns True.

See Also