REST.Backend.EMSApi.TEMSClientAPI.DeleteGroup

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 */;

説明

指定されたグループの削除を EMS サーバーに要求し、成功した場合は True を返し、そうでない場合は False を返します。

対象グループを TGroup のインスタンスとして指定することもできますし、対象グループの名前の文字列を引数として渡してもかまいません。

例外	メッセージ	説明
EEMSClientAPIError	グループ名が必要です	指定されたグループ名が空の文字列になっています。
	MasterSecret が必要です	Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。
	セッショントークンが必要です	Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。