REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroup

From RAD Studio API Documentation
Jump to: navigation, search

Delphi 

function RetrieveGroup(const AGroupName: string; out AGroup: TGroup;  const AJSON: TJSONArray; AProc: TRetrieveGroupProc): Boolean; overload;
function RetrieveGroup(const AGroupName: string; out AFoundGroup: TGroup;  const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveGroup(const AGroupName: string; AProc: TRetrieveGroupProc): Boolean; overload;
function RetrieveGroup(const AGroup: TGroup; out AFoundGroup: TGroup;  const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveGroup(const AGroup: TGroup; AProc: TRetrieveGroupProc): Boolean; overload;

C++ 

bool __fastcall RetrieveGroup(const System::UnicodeString AGroupName, /* out */ TGroup &AGroup, System::Json::TJSONArray* const AJSON, _di_TRetrieveGroupProc AProc)/* overload */;
bool __fastcall RetrieveGroup(const System::UnicodeString AGroupName, /* out */ TGroup &AFoundGroup, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveGroup(const System::UnicodeString AGroupName, _di_TRetrieveGroupProc AProc)/* overload */;
bool __fastcall RetrieveGroup(const TGroup &AGroup, /* out */ TGroup &AFoundGroup, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveGroup(const TGroup &AGroup, _di_TRetrieveGroupProc AProc)/* overload */;

Properties

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

Description

Requests the information of a group from the EMS server and returns True if it receives the information successfully or False otherwise.

To specify the target group, provide either a string with the group name (AObjectname) or an instance of TGroup (AGroup).

To handle the received information, you must provide either of the following:

  • An instance of TGroup (AGroup or AFoundGroup). RetrieveGroup fills the specified object with the received group data.

    You may optionally provide a third argument, an instance of TJSONArray (AJSON), so that RetrieveGroup fills that object with the received group data in JSON format.

  • A procedure of type TRetrieveGroupProc (AProc). RetrieveGroup calls your procedure and provides the received group data both as an instance of TGroup (first argument) and as an instance of TJSONArray (second argument).

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

Retrieved from "http://docwiki.embarcadero.com/Libraries/Rio/e/index.php?title=REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroup&oldid=715355"