EMS.Services.TEMSInternalAPI.DeleteGroup

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 DeleteGroup(const AGroupName: string; out AResponse: IEMSResourceResponseContent): Boolean; overload;
function DeleteGroup(const AGroupName: string): Boolean; overload;

C++

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

Description

Deletes an existing EMS Group from the EMS Server.

The DeleteGroup executes the delete request from the EMS Server for the AGroupName.

The DeleteGroup method is overloaded:

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

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

See Also