REST.Backend.EMSApi.TEMSClientAPI.RetrieveModuleResource

• Übergeordnet: TEMSClientAPI

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 */;

Eigenschaften

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

Beschreibung

Fordert die Informationen einer Modulressource vom EMS-Server an und gibt True zurück, wenn die Informationen erfolgreich empfangen wurden; ansonsten wird False zurückgegeben.

Um die Zielmodulressource festzulegen, geben Sie entweder einen String mit der Modul-ID (AModuleID) und einen String mit dem Namen der Modulressource (AResourceName) oder eine TModuleResource-Instanz (AModuleResource) an.

Stellen Sie für die weitere Behandlung der empfangenen Informationen entweder die folgende Instanz oder die folgende Prozedur bereit:

• Eine Instanz von TModuleResource (AModuleResource oder AFoundModuleResource). RetrieveModuleResource füllt das angegebene Objekt mit den empfangenen Modulressourcedaten.

  Sie können optional ein drittes Argument, eine TJSONArray-Instanz (AJSON), angeben, damit RetrieveModuleResource dieses Objekt mit den empfangenen Modulressourcedaten im JSON-Format füllt.

• Eine Prozedur mit dem Typ TRetrieveModuleResourceProc (AProc). RetrieveModuleResource ruft Ihre Prozedur auf und stellt die erhaltenen Modulressourcedaten sowohl als Instanz von TModuleResource (erstes Argument) als auch als Instanz von TJSONArray (zweites Argument) bereit.

Hinweis: Sie können auch alle drei Parameter kombinieren. Siehe die erste Signatur oben.

Exceptions

Exception	Meldung	Beschreibung
EEMSClientAPIError	MasterSecret erforderlich	Authentication ist TAuthentication.MasterSecret und ConnectionInfo.MasterSecret ist ein leerer String.
	Modul-ID erforderlich	Die angegebene Modul-ID ist ein leerer String.
	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.UnregisterModuleResource
• REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources
• REST.Backend.EMSApi.TEMSClientAPI.UpdateModuleResource
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveModuleResourcesFields

• REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroup
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveModule
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveInstallation