REST.Backend.EMSApi.TEMSClientAPI.RetrieveModule
Delphi
function RetrieveModule(const AModuleID: string; out AModule: TModule; const AJSON: TJSONArray; AProc: TRetrieveModuleProc): Boolean; overload;
function RetrieveModule(const AModuleID: string; out AFoundModule: TModule; const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveModule(const AModuleID: string; AProc: TRetrieveModuleProc): Boolean; overload;
function RetrieveModule(const AModule: TModule; out AFoundModule: TModule; const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveModule(const AModule: TModule; AProc: TRetrieveModuleProc): Boolean; overload;
C++
bool __fastcall RetrieveModule(const System::UnicodeString AModuleID, /* out */ TModule &AModule, System::Json::TJSONArray* const AJSON, _di_TRetrieveModuleProc AProc)/* overload */;
bool __fastcall RetrieveModule(const System::UnicodeString AModuleID, /* out */ TModule &AFoundModule, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveModule(const System::UnicodeString AModuleID, _di_TRetrieveModuleProc AProc)/* overload */;
bool __fastcall RetrieveModule(const TModule &AModule, /* out */ TModule &AFoundModule, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveModule(const TModule &AModule, _di_TRetrieveModuleProc AProc)/* overload */;
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
EMS サーバーにモジュールの情報を要求し、その情報を正常に受け取った場合は True を返し、そうでない場合は False を返します。
対象となるモジュールを指定するには、モジュール名の文字列（AModuleID）か TModule インスタンス（AModule）のどちらかを引数として渡します。
受け取った情報を処理するには、次のいずれかを引数として渡す必要があります。
- TModule のインスタンス（
AModuleまたはAFoundModule）。RetrieveModule では、受け取ったモジュール データをこの指定オブジェクトに格納します。オプションで、TJSONArray のインスタンスを第 3 引数（
AJSON）として渡してもかまいません。その場合、RetrieveModule では、受け取ったモジュール データをこのオブジェクトに JSON 形式で格納します。
- TRetrieveModuleProc 型の手続き（
AProc）。RetrieveModule では、受け取ったモジュール データを TModule のインスタンス（第 1 引数）として、および、TJSONArray のインスタンス（第 2 引数）として渡して、この手続きを呼び出します。
例外
| 例外 | メッセージ | 説明 |
|---|---|---|
|
MasterSecret が必要です |
Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
|
モジュール ID が必要です |
指定されたモジュール ID が空の文字列になっています。 | |
|
セッション トークンが必要です |
Authentication が TAuthentication.Session で、かつ、ログインしなかったか、Login に渡したセッション認証トークンが空の文字列になっています。 |