REST.Backend.EMSServices.TEMSUsersAPI.QueryUserName

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

Delphi

function QueryUserName(const AUserName: string; AProc: TFindObjectProc)
function QueryUserName(const AUserName: string;
out AUser: TBackendEntityValue; const AJSON: TJSONArray)

C++

bool __fastcall QueryUserName(const System::UnicodeString AUserName, Rest::Backend::Servicetypes::_di_TFindObjectProc AProc)/* overload */;
bool __fastcall QueryUserName(const System::UnicodeString AUserName, /* out */ Rest::Backend::Metatypes::TBackendEntityValue &AUser, System::Json::TJSONArray* const AJSON)/* overload */;

プロパティ

種類 可視性 ソース ユニット
function protected
REST.Backend.EMSServices.pas
REST.Backend.EMSServices.hpp
REST.Backend.EMSServices TEMSUsersAPI


説明

指定されたユーザー名を持つユーザーのデータを EMS サーバーに問い合わせ、指定されたユーザー名のユーザーが EMS サーバーに存在する場合は True を返し、そうでない場合は False を返します。

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

  • TBackendEntityValue のインスタンス(AUser)と TJSONArray のインスタンス(AJSON)。QueryUserName では、受け取ったユーザー データを両方のオブジェクトに格納します。
  • TFindObjectProc 型の手続き(AProc)。QueryUserName では、受け取ったユーザー データを TBackendEntityValue のインスタンス(第 1 引数)として、および、TJSONObject のインスタンス(第 2 引数)として渡して、この手続きを呼び出します。

例外

例外 メッセージ 説明

EEMSClientAPIError

MasterSecret が必要です

認証の種類TAuthentication.MasterSecret で、基になる EMS バックエンド サービス接続情報MasterSecret プロパティが空の文字列になっています。

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

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

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

認証の種類TAuthentication.Session で、かつ、ログインが行われませんでした。

関連項目