REST.Backend.EMSApi.TEMSClientAPI.QueryUserName

De RAD Studio API Documentation
Aller à : navigation, rechercher

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 */;

Propriétés

Type Visibilité  Source Unité  Parent
function public
REST.Backend.EMSApi.pas
REST.Backend.EMSApi.hpp
 REST.Backend.EMSApi TEMSClientAPI


Description

Demande au serveur EMS les données d'un utilisateur ayant le nom d'utilisateur spécifié et renvoie True si un utilisateur du nom spécifié existe dans le serveur EMS ou False dans le cas contraire.

Pour traiter les informations reçues, vous pouvez fournir l'un des paramètres suivants :

  • AUser est une instance de TUser que RetrieveUser remplit avec les données d'utilisateur reçues.
  • AJSON est une instance de TJSONArray que RetrieveUser remplit avec les données d'utilisateur reçues au format JSON.
  • AProc est une procédure du type TQueryUserNameProc. RetrieveUser appelle votre procédure et fournit les données d'utilisateur reçues à la fois en tant qu'instance de TUser (premier argument) et qu'instance de TJSONArray (second argument).
Remarque : QueryUserName prend en charge différentes combinaisons de ces paramètres (voir la signature de la fonction ci-dessus).

Exceptions

Exception Message Description

EEMSClientAPIError

MasterSecret requis

Authentication a la valeur TAuthentication.MasterSecret, et ConnectionInfo.MasterSecret est une chaîne vide.

Un utilisateur attendu

Le serveur EMS a renvoyé plus d'un utilisateur pour le nom d'utilisateur spécifié.

Token de session requis

Authentication a la valeur TAuthentication.Session, et vous ne vous êtes pas connecté ou le token d'authentification de session fourni lors de la connexion est une chaîne vide.

Voir aussi

Récupérée de « https://docwiki.embarcadero.com/Libraries/Sydney/f/index.php?title=REST.Backend.EMSApi.TEMSClientAPI.QueryUserName&oldid=679431 »