REST.Backend.EMSApi.TEMSClientAPI.DeleteGroup

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function DeleteGroup(const AGroupName: string): Boolean; overload;
function DeleteGroup(const AGroup: TGroup): Boolean; overload;

C++

bool __fastcall DeleteGroup(const System::UnicodeString AGroupName)/* overload */;
bool __fastcall DeleteGroup(const TGroup &AGroup)/* overload */;

Properties

Type Visibility Source Unit Parent
function public
REST.Backend.EMSApi.pas
REST.Backend.EMSApi.hpp
REST.Backend.EMSApi TEMSClientAPI

Description

Requests the deletion of the specified group from the EMS server and returns True on success or False otherwise.

You may specify the target group as an instance of TGroup, or provide a string with the name of the target group.

Exceptions

Exception Message Description

EEMSClientAPIError

Group name required

The specified group name is an empty string.

MasterSecret required

Authentication is TAuthentication.MasterSecret and ConnectionInfo.MasterSecret is an empty string.

Session token required

Authentication is TAuthentication.Session and you did not log in or the session authentication token that you provided to Login is an empty string.

See Also