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


TMsgClient.IsUserOnLine
TMsgClient
Top 

Checks for the user status.

function IsUserOnLine(UserID: Cardinal): Integer;

Description
Call IsUserOnLine to determine if user with UserID is on-line now or not. IsUserOnLine sends command to the server, waits for an answer, and returns MSG_COMMAND_RESULT_TRUE if user with this UserID is on-line now, or MSG_COMMAND_RESULT_FALSE if it is off-line, or in case of the error occurs, it returns one of the following error codes:

Name
Value
MSG_Error_IsUserOnLine_NotConnected   
MSG_Error_IsUserOnLine_SendCommandFailed   
MSG_Error_IsUserOnLine_ReceiveResultFailed   
MSG_Error_IsUserOnLine_InvalidParams   
MSG_Error_IsUserOnLine_InvalidServerReply
MSG_Error_IsUserOnLine_Failed
MSG_Error_IsUserOnline_NotLogged
60020   
60021   
60022   
60023   
60024   
60025   
60104


If a user with this UserID is not registered on the server, IsUserOnLine returns MSG_COMMAND_RESULT_FALSE as it is off-line. If you would like to check is the user with this UserID registered on the server, you can call IsUserExisting.

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



© AidAim Software MsgCommunicator: