MsgCommunicator: Delphi Instant Messaging (IM) SDK
for easy creation of custom messenger system


TMsgClient.GetUserInfo
TMsgClient
Top 

Gets user's details.

function GetUserInfo(UserID: Cardinal; var UserInfo:TMsgUserInfo): Integer;

Description
Call GetUserInfo to get detais of user whit ID equals to UserID. GetUserInfo sends command to the server, waits for an answer, and returns MSG_COMMAND_OK code and user's details in UserInfo record in case the user exists, otherwise returns one of the following error codes:

Name
Value
MSG_Error_GetUserInfo_NotConnected   
MSG_Error_GetUserInfo_SendCommandFailed   
MSG_Error_GetUserInfo_ReceiveResultFailed   
MSG_Error_GetUserInfo_InvalidParams   
MSG_Error_GetUserInfo_UserDoesNotExist   
MSG_Error_GetUserInfo_InvalidServerReply
MSG_Error_GetUserInfo_NotLogged
60003   
60004   
60005   
60006   
60007   
60008   
60105


If there is no registered user with UserID at the server which client is configured to work with, UserInfo.UserID will be equal to MSG_INVALID_USER_ID and UserInfo.UserName will be empty string. If user is not exist or is not connected to the server, UserInfo.Status is msgOffLine, UserInfo.Host is empty string, and UserInfo.Port is equal to 0.

If you need only to know is user with UserID registered on the server or not, you can call IsUserExisting.

Here you can see the full list of the Return Codes and Error Codes of Client Methods.



© AidAim Software MsgCommunicator: Delphi Messenger Sdk Instant Messaging Sdk Im Sd