REST.Backend.EMSApi.TEMSClientAPI.RetrieveModuleResource
Delphi
function RetrieveModuleResource(const AModuleID, AResourceName: string; out AResource: TModuleResource;
const AJSON: TJSONArray; AProc: TRetrieveModuleResourceProc): Boolean; overload;
function RetrieveModuleResource(const AModuleID, AResourceName: string; out AFoundResource: TModuleResource;
const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveModuleResource(const AModuleID, AResourceName: string; AProc: TRetrieveModuleResourceProc): Boolean; overload;
function RetrieveModuleResource(const AResource: TModuleResource; out AFoundResource: TModuleResource;
const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveModuleResource(const AResource: TModuleResource; AProc: TRetrieveModuleResourceProc): Boolean; overload;
C++
bool __fastcall RetrieveModuleResource(const System::UnicodeString AModuleID, const System::UnicodeString AResourceName, /* out */ TModuleResource &AResource, System::Json::TJSONArray* const AJSON, _di_TRetrieveModuleResourceProc AProc)/* overload */;
bool __fastcall RetrieveModuleResource(const System::UnicodeString AModuleID, const System::UnicodeString AResourceName, /* out */ TModuleResource &AFoundResource, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveModuleResource(const System::UnicodeString AModuleID, const System::UnicodeString AResourceName, _di_TRetrieveModuleResourceProc AProc)/* overload */;
bool __fastcall RetrieveModuleResource(const TModuleResource &AResource, /* out */ TModuleResource &AFoundResource, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveModuleResource(const TModuleResource &AResource, _di_TRetrieveModuleResourceProc 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'une ressource de module à partir du serveur EMS et renvoie True s'il reçoit les informations ou False dans le cas contraire.
Pour spécifier la ressource de module cible, fournissez une chaîne avec l'ID de module (AModuleID) et une chaîne avec le nom de la ressource de module (AResourceName) ou une instance de TModuleResource (AModuleResource).
Pour gérer les informations reçues, vous devez fournir l'un des éléments suivants :
- Une instance de TModuleResource (
AModuleResourceouAFoundModuleResource). RetrieveModuleResource remplit l'objet spécifié avec les données de ressource de module reçues.Vous pouvez facultativement fournir un troisième argument, une instance de TJSONArray (
AJSON) pour que RetrieveModuleResource remplisse cet objet avec les données de ressource de module reçues au format JSON.
- Une procédure de type TRetrieveModuleResourceProc (
AProc). RetrieveModuleResource appelle votre procédure et fournit les données de ressource de module reçues à la fois en tant qu'instance de TModuleResource (premier argument) et qu'instance de TJSONArray (second argument).
- Remarque : Vous pouvez aussi combiner les trois paramètres. Voir la première signature ci-dessus.
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. |