REST.Backend.EMSApi.TEMSClientAPI.QueryModules

提供: RAD Studio API Documentation
移動先: 案内、 検索

Delphi 

procedure QueryModules(const AQuery: array of string; const AJSONArray: TJSONArray); overload;
procedure QueryModules(const AQuery: array of string;  const AJSONArray: TJSONArray; out AModules: TArray<TModule>); overload;

C++ 

void __fastcall QueryModules(const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray)/* overload */;
void __fastcall QueryModules(const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray, /* out */ System::DynamicArray<TModule> &AModules)/* overload */;

プロパティ

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


説明

EMS サーバーにモジュールのリストを問い合わせます。

QueryModules が受け取るパラメータは次のとおりです。

  • AQuery： 等号で区切られたキーと値のペアの文字列（たとえば、"my_parameter=my_value" など）を要素とする文字列配列です。QueryModules では、これらのキー/値ペアをパラメータとして要求に追加します。
  • AJSONArray： QueryModules で EMS サーバーから取得された結果の格納先です。

オプションで、TModule インスタンスの配列（AModules）を引数として渡すこともできます｡その場合、QueryModules では、EMS サーバーから返されたモジュールをその配列に格納します。

例外

例外 メッセージ 説明

EEMSClientAPIError

JSON オブジェクトが必要です

QueryModules に TModule インスタンスの配列（AModules）が渡されましたが、QueryModules では、EMS サーバーから受け取った JSON データの構造が予期しないものであるため、その配列にデータを格納できません。

受け取る JSON データの構造としては、JSON オブジェクトの JSON 配列が想定されています。それらのオブジェクトのそれぞれが 1 人のユーザーを表します。

受け取る JSON データの実際の構造は、JSON オブジェクトでない項目が 1 つ以上含まれている JSON 配列です。

MasterSecret が必要です

Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。

セッション トークンが必要です

Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。

関連項目

「http://docwiki.embarcadero.com/Libraries/Sydney/j/index.php?title=REST.Backend.EMSApi.TEMSClientAPI.QueryModules&oldid=683511」から取得