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

TMsgClient.UpdateUserInContacts
TMsgClient
Top 
Updates a user in contacts list of this client.

function UpdateUserInContacts(UserID: Cardinal; ContactNameSource: TMsgContactNameSource = mcnsUserName; ContactCustomName: ShortString = ''): Integer;

Description
Call UpdateUserInContacts to update a user in contact list of this client. UpdateUserInContacts sends command to the server, waits for an answer, then updates local contacts list of this client and returns MSG_COMMAND_OK if this operation executed successfully, otherwise it returns one of the following error codes:

Name
Value
MSG_Error_UpdateUserInContacts_NotConnected   
MSG_Error_UpdateUserInContacts_SendCommandFailed   
MSG_Error_UpdateUserInContacts_ReceiveResultFailed   
MSG_Error_UpdateUserInContacts_InvalidParams   
MSG_Error_UpdateUserInContacts_InvalidServerReply   
MSG_Error_UpdateUserInContacts_Failed   
MSG_Error_UpdateUserInContacts_UserDoesNotExist
MSG_Error_UpdateUserInContacts_NotLogged
60047   
60048   
60049   
60050   
60051   
60052   
60053
60108


You can specify ContactNameSource to set a format for a visible name or even set custom name by specifying ContactCustomName and setting ContactNameSource to mcnsCustom. Read about TMsgContactNameSource type to learn details.

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


© AidAim Software MsgCommunicator: