REST.Backend.EMSServices.TEMSUsersAPI.QueryUserName
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 */;
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | protected | REST.Backend.EMSServices.pas REST.Backend.EMSServices.hpp |
REST.Backend.EMSServices | TEMSUsersAPI |
Description
Queries the EMS server for the data of a user with the specified username and returns True if a user with the specified username exists in the EMS server or False otherwise.
To handle the received information, you must provide either of the following:
- An instance of TBackendEntityValue (
AUser) and an instance of TJSONArray (AJSON). QueryUserName fills both objects with the received user data. - A procedure of type TFindObjectProc (
AProc). QueryUserName calls your procedure and provides the received user data both as an instance of TBackendEntityValue (first argument) and as an instance of TJSONObject (second argument).
Exceptions
| Exception | Message | Description |
|---|---|---|
|
MasterSecret required |
The type of authentication is TAuthentication.MasterSecret and the MasterSecret property of the connection information of the underlying EMS backend service is an empty string. | |
|
One user expected |
The EMS server returned more than one user for the specified username. | |
|
Session token required |
The type of authentication is TAuthentication.Session you did not log in. |