REST.Backend.EMSApi.TEMSClientAPI.QueryModuleName

• Übergeordnet: 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 */;

Eigenschaften

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

Beschreibung

Fragt den EMS-Server nach den Daten eines Moduls mit dem angegebenen Modulnamen ab und gibt True zurück, wenn ein Modul mit dem angegebenen Modulnamen auf dem EMS-Server vorhanden ist; ansonsten wird False zurückgegeben.

Für die weitere Behandlung der empfangenen Informationen können Sie die folgenden Parameter bereitstellen:

• AModule ist eine TModule-Instanz, die RetrieveModule mit den erhaltenen Moduldaten füllt.
• AJSON ist eine TJSONArray-Instanz, die RetrieveModule mit den erhaltenen Moduldaten im JSON-Format füllt.
• AProc ist eine Prozedur mit dem Typ TQueryModuleNameProc. RetrieveModule ruft Ihre Prozedur auf und stellt die erhaltenen Moduldaten sowohl als Instanz von TModule (erstes Argument) als auch als Instanz von TJSONArray (zweites Argument) bereit.

Hinweis: QueryModuleName unterstützt verschiedene Kombinationen dieser Parameter; siehe die Signatur der Funktion oben.

Exceptions

Exception	Meldung	Beschreibung
EEMSClientAPIError	MasterSecret erforderlich	Authentication ist TAuthentication.MasterSecret und ConnectionInfo.MasterSecret ist ein leerer String.
	Ein Modul erwartet	Der EMS-Server hat mehr als ein Modul für den angegebenen Modulnamen zurückgegeben.
	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

• 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