REST.Backend.EMSApi.TEMSClientAPI.QueryModuleName

• Aller au parent : TEMSClientAPI

Delphi

function QueryModuleName(const AModuleName: string; out AModule: TModule;  const AJSON: TJSONArray; AProc: TQueryModuleNameProc): Boolean; overload;
function QueryModuleName(const AModuleName: string; AProc: TQueryModuleNameProc): Boolean; overload;
function QueryModuleName(const AModuleName: string; out AModule: TModule;  const AJSON: TJSONArray = nil): Boolean; overload;

C++

bool __fastcall QueryModuleName(const System::UnicodeString AModuleName, /* out */ TModule &AModule, System::Json::TJSONArray* const AJSON, _di_TQueryModuleNameProc AProc)/* overload */;
bool __fastcall QueryModuleName(const System::UnicodeString AModuleName, _di_TQueryModuleNameProc AProc)/* overload */;
bool __fastcall QueryModuleName(const System::UnicodeString AModuleName, /* out */ TModule &AModule, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* 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 au serveur EMS les données d'un module ayant le nom de module spécifié et renvoie True si un module du nom spécifié existe dans le serveur EMS ou False dans le cas contraire.

Pour traiter les informations reçues, vous pouvez fournir l'un des paramètres suivants :

• AModule est une instance de TModule que RetrieveModule remplit avec les données de module reçues.
• AJSON est une instance de TJSONArray que RetrieveModule remplit avec les données de module reçues au format JSON.
• AProc est une procédure du type TQueryModuleNameProc. 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).

Remarque : QueryModuleName prend en charge différentes combinaisons de ces paramètres (voir la signature de la fonction ci-dessus).

Exceptions

Exception	Message	Description
EEMSClientAPIError	MasterSecret requis	Authentication a la valeur TAuthentication.MasterSecret, et ConnectionInfo.MasterSecret est une chaîne vide.
	Un module est attendu	Le serveur EMS a renvoyé plus d'un module pour le nom de module spécifié.
	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

• REST.Backend.EMSApi.TEMSClientAPI.RegisterModule
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveModule
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveModulesFields
• REST.Backend.EMSApi.TEMSClientAPI.UpdateModule
• REST.Backend.EMSApi.TEMSClientAPI.QueryModules
• REST.Backend.EMSApi.TEMSClientAPI.UnregisterModule

• REST.Backend.EMSApi.TEMSClientAPI.QueryUserName