REST.Backend.EMSApi.TEMSClientAPI.QueryUserName
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 */;
Inhaltsverzeichnis
Eigenschaften
Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
---|---|---|---|---|
function | public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
Beschreibung
Fragt den EMS-Server nach den Daten eines Benutzers mit dem angegebenen Benutzernamen ab und gibt True
zurück, wenn ein Benutzer mit dem angegebenen Benutzernamen auf dem EMS-Server vorhanden ist; ansonsten wird False
zurückgegeben.
Für die weitere Behandlung der empfangenen Informationen können Sie die folgenden Parameter bereitstellen:
AUser
ist eine TUser-Instanz, die RetrieveUser mit den erhaltenen Benutzerdaten füllt.AJSON
ist eine TJSONArray-Instanz, die RetrieveUser mit den erhaltenen Benutzerdaten im JSON-Format füllt.AProc
ist eine Prozedur mit dem Typ TQueryUserNameProc. RetrieveUser ruft Ihre Prozedur auf und stellt die erhaltenen Benutzerdaten sowohl als Instanz von TUser (erstes Argument) als auch als Instanz von TJSONArray (zweites Argument) bereit.
- Hinweis: QueryUserName unterstützt verschiedene Kombinationen dieser Parameter; siehe die Signatur der Funktion oben.
Exceptions
Exception | Meldung | Beschreibung |
---|---|---|
MasterSecret erforderlich |
Authentication ist TAuthentication.MasterSecret und ConnectionInfo.MasterSecret ist ein leerer String. | |
Ein Benutzer erwartet |
Der EMS-Server hat mehr als einen Benutzer für den angegebenen Benutzernamen zurückgegeben. | |
Sitzungs-Token erforderlich |
Authentication ist TAuthentication.Session, und Sie haben sich nicht angemeldet oder das bei der Anmeldung (Login) angegebene Sitzungsauthentifizierungs-Token ist ein leerer String. |
Siehe auch
- REST.Backend.EMSApi.TEMSClientAPI.AddUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveCurrentUser
- REST.Backend.EMSApi.TEMSClientAPI.UpdateUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersNames
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersFields
- REST.Backend.EMSApi.TEMSClientAPI.QueryUsers
- REST.Backend.EMSApi.TEMSClientAPI.SignupUser
- REST.Backend.EMSApi.TEMSClientAPI.LoginUser
- REST.Backend.EMSApi.TEMSClientAPI.LogoutUser
- REST.Backend.EMSApi.TEMSClientAPI.DeleteUser