REST.Backend.EMSApi.TEMSClientAPI.QueryUserName

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

Delphi 

function QueryUserName(const AUserName: string; out AUser: TUser;
const AJSON: TJSONArray; AProc: TQueryUserNameProc): Boolean; overload;
function QueryUserName(const AUserName: string; AProc: TQueryUserNameProc): Boolean; overload;
function QueryUserName(const AUserName: string; out AUser: TUser;
const AJSON: TJSONArray = nil): Boolean; overload;

C++ 

bool __fastcall QueryUserName(const System::UnicodeString AUserName, /* out */ TUser &AUser, System::Json::TJSONArray* const AJSON, _di_TQueryUserNameProc AProc)/* overload */;
bool __fastcall QueryUserName(const System::UnicodeString AUserName, _di_TQueryUserNameProc AProc)/* overload */;
bool __fastcall QueryUserName(const System::UnicodeString AUserName, /* out */ TUser &AUser, 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 を返します。

受け取った情報を処理するため、次のパラメータを指定することができます。

  • AUser： RetrieveUser で受け取ったユーザー データのTUser インスタンスです。
  • AJSON： RetrieveUser で受け取ったユーザー データを JSON 形式で格納する場所となる TJSONArray インスタンスです。
  • AProc： TQueryUserNameProc 型の手続きです。RetrieveUser では、受け取ったユーザー データを TUser のインスタンス（第 1 引数）として、および、TJSONArray のインスタンス（第 2 引数）として渡して、この手続きを呼び出します。
メモ： QueryUserName では、これらのパラメータのさまざまな組み合わせをサポートしています。上記の関数シグネチャを参照してください。

例外

例外 メッセージ 説明

EEMSClientAPIError

MasterSecret が必要です

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

1 名のユーザーが必要です

指定されたユーザー名のユーザーが EMS サーバーから複数返されました。

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

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

関連項目

「https://docwiki.embarcadero.com/Libraries/Alexandria/j/index.php?title=REST.Backend.EMSApi.TEMSClientAPI.QueryUserName&oldid=683515」から取得