REST.Backend.EMSApi.TEMSClientAPI.RetrieveInstallation

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

function RetrieveInstallation(const AInstallationID: string; out AFoundInstallation: TInstallation;
const AJSON: TJSONArray; AProc: TRetrieveInstallationProc;
AReset: Boolean): Boolean; overload;
function RetrieveInstallation(const AInstallationID: string; out AFoundInstallation: TInstallation;
const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveInstallation(const AInstallationID: string; AProc: TRetrieveInstallationProc): Boolean; overload;
function RetrieveInstallation(const AInstallation: TInstallation; out AFoundInstallation: TInstallation;
const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveInstallation(const AInstallation: TInstallation; AProc: TRetrieveInstallationProc): Boolean; overload;

C++

bool __fastcall RetrieveInstallation(const System::UnicodeString AInstallationID, /* out */ TInstallation &AFoundInstallation, System::Json::TJSONArray* const AJSON, _di_TRetrieveInstallationProc AProc, bool AReset)/* overload */;
bool __fastcall RetrieveInstallation(const System::UnicodeString AInstallationID, /* out */ TInstallation &AFoundInstallation, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveInstallation(const System::UnicodeString AInstallationID, _di_TRetrieveInstallationProc AProc)/* overload */;
bool __fastcall RetrieveInstallation(const TInstallation &AInstallation, /* out */ TInstallation &AFoundInstallation, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveInstallation(const TInstallation &AInstallation, _di_TRetrieveInstallationProc 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 installation à partir du serveur EMS et renvoie True s'il reçoit les informations ou False dans le cas contraire.

Pour spécifier l'installation cible, fournissez une chaîne avec l'identifiant d'installation (AObjectID) ou une instance de TInstallation (AInstallation).

Pour gérer les informations reçues, vous devez fournir l'un des éléments suivants :

  • Une instance de TInstallation (AInstallation ou AFoundInstallation). RetrieveInstallation remplit l'objet spécifié avec les données d'installation reçues.

    Vous pouvez facultativement fournir un troisième argument, une instance de TJSONArray (AJSON) pour que RetrieveInstallation remplisse cet objet avec les données d'installation reçues au format JSON.

Exceptions

Exception Message Description

EEMSClientAPIError

ID d'installation requise

L'identifiant de l'installation spécifiée est une chaîne vide.

MasterSecret requis

Authentication a la valeur TAuthentication.MasterSecret, et ConnectionInfo.MasterSecret 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.

Voir aussi