REST.Backend.EMSApi.TEMSClientAPI.RetrieveModule

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function RetrieveModule(const AModuleID: string; out AModule: TModule;
const AJSON: TJSONArray; AProc: TRetrieveModuleProc): Boolean; overload;
function RetrieveModule(const AModuleID: string; out AFoundModule: TModule;
const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveModule(const AModuleID: string; AProc: TRetrieveModuleProc): Boolean; overload;
function RetrieveModule(const AModule: TModule; out AFoundModule: TModule;
const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveModule(const AModule: TModule; AProc: TRetrieveModuleProc): Boolean; overload;

C++

bool __fastcall RetrieveModule(const System::UnicodeString AModuleID, /* out */ TModule &AModule, System::Json::TJSONArray* const AJSON, _di_TRetrieveModuleProc AProc)/* overload */;
bool __fastcall RetrieveModule(const System::UnicodeString AModuleID, /* out */ TModule &AFoundModule, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveModule(const System::UnicodeString AModuleID, _di_TRetrieveModuleProc AProc)/* overload */;
bool __fastcall RetrieveModule(const TModule &AModule, /* out */ TModule &AFoundModule, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveModule(const TModule &AModule, _di_TRetrieveModuleProc AProc)/* overload */;

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
REST.Backend.EMSApi.pas
REST.Backend.EMSApi.hpp
REST.Backend.EMSApi TEMSClientAPI


Beschreibung

Fordert die Informationen eines Moduls vom EMS-Server an und gibt True zurück, wenn die Informationen erfolgreich empfangen wurden; ansonsten wird False zurückgegeben.

Um das Zielmodul festzulegen, geben Sie entweder einen String mit dem Modulnamen (AModuleID) oder eine TModule-Instanz (AModule) an.

Stellen Sie für die weitere Behandlung der empfangenen Informationen entweder die folgende Instanz oder die folgende Prozedur bereit:

  • Eine Instanz von TModule (AModule oder AFoundModule). RetrieveModule füllt das angegebene Objekt mit den empfangenen Moduldaten.

    Sie können optional ein drittes Argument, eine TJSONArray-Instanz (AJSON), angeben, damit RetrieveModule dieses Objekt mit den empfangenen Moduldaten im JSON-Format füllt.

Exceptions

Exception Meldung Beschreibung

EEMSClientAPIError

MasterSecret erforderlich

Authentication ist TAuthentication.MasterSecret und ConnectionInfo.MasterSecret ist ein leerer String.

Modul-ID erforderlich

Die angegebene Modul-ID ist ein leerer String.

Sitzungs-Token erforderlich

Authentication ist TAuthentication.Session, und Sie haben sich nicht angemeldet oder das bei der Anmeldung (Login) angegebene Sitzungsauthentifizierungs-Token ist ein leerer String.

Siehe auch