EMS.Services.TEMSInternalAPI.DeleteUser

• Up to Parent: TEMSInternalAPI

Delphi

function DeleteUser(const AObjectID: string; out AResponse: IEMSResourceResponseContent): Boolean; overload;
function DeleteUser(const AObjectID: string): Boolean; overload;

C++

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

Properties

Type	Visibility	Source	Unit	Parent
function	public	EMS.Services.pas EMS.Services.hpp	EMS.Services	TEMSInternalAPI

Description

Deletes an existing EMS User from the EMS Server.

The DeleteUser executes the delete request to the EMS Server for the AObjectID (the EMS user identifier).

The DeleteUser method is overloaded:

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

DeleteUser returns True if the response request status code is different from 404 (the EMS User is Not found). Otherwise, DeleteUser returns False.

See Also

• EMS.Services.IEMSResourceRequest.Delete
• EMS.Services.TEMSInternalAPI.AddUser
• EMS Users Resource
• EMS Administrative API