REST.Backend.EMSApi.TEMSClientAPI.RetrieveModule
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 */;
Propriétés
Type | Visibilité | Source | Unité | Parent |
---|---|---|---|---|
function | public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
Description
Demande les informations d'un module à partir du serveur EMS et renvoie True
s'il reçoit les informations ou False
dans le cas contraire.
Pour spécifier le module cible, fournissez une chaîne avec le nom du module (AModuleID
) ou une instance de TModule (AModule
).
Pour gérer les informations reçues, vous devez fournir l'un des éléments suivants :
- Une instance de TModule (
AModule
ouAFoundModule
). RetrieveModule remplit l'objet spécifié avec les données de module reçues.Vous pouvez éventuellement fournir un troisième argument, une instance de TJSONArray (
AJSON
) pour que RetrieveModule remplisse cet objet avec les données de module reçues au format JSON.
- Une procédure de type TRetrieveModuleProc (
AProc
). RetrieveModule appelle votre procédure et fournit les données de module reçues à la fois en tant qu'instance de TModule (premier argument) et qu'instance de TJSONArray (second argument).
Exceptions
Exception | Message | Description |
---|---|---|
MasterSecret requis |
Authentication a la valeur TAuthentication.MasterSecret, et ConnectionInfo.MasterSecret est une chaîne vide. | |
ID de module requis |
L'ID de module spécifié est une chaîne vide. | |
Token de session requis |
Authentication a la valeur TAuthentication.Session, et vous ne vous êtes pas connecté ou le token d'authentification de session fourni lors de la connexion est une chaîne vide. |