REST.Backend.EMSApi.TEMSClientAPI.QueryModuleName
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 */;
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
指定されたモジュール名を持つモジュールのデータを EMS サーバーに問い合わせ、指定されたモジュール名のモジュールが EMS サーバーに存在する場合は True を返し、そうでない場合は False を返します。
受け取った情報を処理するため、次のパラメータを指定することができます。
AModule： RetrieveModule で受け取ったモジュール データの格納先となる TModule インスタンスです。AJSON： RetrieveModule で受け取ったモジュール データを JSON 形式で格納する場所となる TJSONArray インスタンスです。AProc： TQueryModuleNameProc 型の手続きです。RetrieveModule では、受け取ったモジュール データを TModule のインスタンス（第 1 引数）として、および、TJSONArray のインスタンス（第 2 引数）として渡して、この手続きを呼び出します。
- メモ： QueryModuleName では、これらのパラメータのさまざまな組み合わせをサポートしています。上記の関数シグネチャを参照してください。
例外
| 例外 | メッセージ | 説明 |
|---|---|---|
|
MasterSecret が必要です |
Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
|
1 つのモジュールが必要です |
指定されたモジュール名のモジュールが複数、EMS サーバーから返されました。 | |
|
セッション トークンが必要です |
Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。 |