REST.Backend.EMSApi.TEMSClientAPI.RetrieveModuleResource

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

プロパティ

種類	可視性	ソース	ユニット	親
function	public	REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp	REST.Backend.EMSApi	TEMSClientAPI

説明

EMS サーバーにモジュール リソースの情報を要求し、その情報を正常に受け取った場合は True を返し、そうでない場合は False を返します。

対象となるモジュール リソースを指定するには、モジュール ID の文字列（AModuleID）とモジュール リソース名の文字列（AResourceName）か、TModuleResource インスタンス（AModuleResource）のどちらかを引数として渡します。

受け取った情報を処理するには、次のいずれかを引数として渡す必要があります。

• TModuleResource のインスタンス（AModuleResource または AFoundModuleResource）。RetrieveModuleResource では、受け取ったモジュール リソース データをこの指定オブジェクトに格納します。

  オプションで、TJSONArray のインスタンスを第 3 引数（AJSON）として渡してもかまいません。その場合、RetrieveModuleResource では、受け取ったモジュール リソース データをこのオブジェクトに JSON 形式で格納します。

• TRetrieveModuleResourceProc 型の手続き（AProc）。RetrieveModuleResource では、受け取ったモジュール リソース データを TModuleResource のインスタンス（第 1 引数）として、および、TJSONArray のインスタンス（第 2 引数）として渡して、この手続きを呼び出します。

メモ： 3 つのパラメータをすべて組み合わせることもできます。上記の第 1 のシグネチャを参照してください。

例外

例外	メッセージ	説明
EEMSClientAPIError	MasterSecret が必要です	Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。
	モジュール ID が必要です	指定されたモジュール ID が空の文字列になっています。
	セッション トークンが必要です	Authentication が TAuthentication.Session で、かつ、ログインしなかったか、Login に渡したセッション認証トークンが空の文字列になっています。

関連項目

• 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