Available Extended Codes

---

The error codes provided in the table below returned in the ReturnCode parameter by functions of the IServerClientVBA interface. To get a description for the error code on run-time use the IServerClientVBA::GetEventDescription function.

The constants below are defined in CSClient4.bas module which is installed as a part of Bopup IM Client SDK and available at \include subfolder in installation root directory. That module must be imported to a VBA project in order to properly call IServerClientVBA interface methods. To import the module open VBA project and right-click on Modules in the project left tree, then browse and select the file. The module will be added to the project itself and not as a reference to an external file so there are no needs to copy the module file if you wish to distribute a macro to another computers.

List of Event Codes

SUCCESS	Operation is successful
ERROR_TIMEOUT_EXPIRED	Operation timeout was expired. Try to perform the operation again.
ERROR_UNKNOWN	Unknown error returned. Try to perform the operation again.
ERROR_SQL	SQL error was occurred on the IM server. Try to perform the operation again.
ERROR_SECURE	Encryption error was returned by the client module or by the IM server. Try to perform the operation again.
ERROR_INTERNAL	Unknown internal error occurred on the client or on the IM server. Try to perform the operation again.
ERROR_CANNOT_CONNECT	The IM server is not found or is not running. Check the server address and try to connect to the server again.
ERROR_SEND	Network error occurred while sending the data. Try to perform the operation again.
ERROR_RECEIVE	Network error occurred while receiving the data. Try to perform the operation again.
ERROR_PROTOCOL	Current protocol version on the client is not compatible with the IM server. Update the client or the IM server software.
ERROR_CANNOT_START	Error occurred while initializing internal message loop on the IM client.
ERROR_CONNECTION_LIMIT	Current connection cannot be accepted by the IM server because it's software license does not support such number of concurrent users.
ERROR_LICENSE_EXPIRED	The software license on the IM server expired.
ERROR_PACKAGE_UPDATE	An update for the client software will be sent from the IM server.
ERROR_SERVER_BUSY	The IM server is currently busy and it cannot accept the request at this time. Try to perform the operation again.
ERROR_AUTHENTICATION	Authentication error. Check the user name and password.
ERROR_AUTHENTICATION_WINDOWS	Authorization via Windows Authentication is required to connect to the IM server.
ERROR_AUTHENTICATION_PASSWORD	Authorization via login and password is required to connect to the IM server.
ERROR_AUTHENTICATION_SIMPLE	Simple authentication is required to connect to the IM server.
ERROR_INVALID_PARAM	Invalid parameters are passed to the function.
ERROR_NOT_CONNECTED	The IM client is not currently connected to the IM server to perform the request.
ERROR_ALREADY_CONNECTED	The IM client is already connected to the IM server
ERROR_NOT_SUPPORTED	The IM client does not support the request.
ERROR_SESSION_INVALID	Current session with the IM server is invalid. Disconnect and connect to the IM server again.
ERROR_ACCOUNT_INVALID	User account was not found on the IM server.
ERROR_ACCOUNT_INVALID_MAY_CREATE	User account was not found on the IM server but it is possible to create account from the IM client.
ERROR_ACCOUNT_DISABLED	User account is disabled on the IM server.
ERROR_ACCOUNT_READONLY	User account is set as read-only on the IM server and cannot be changed by the user.
ERROR_ACCOUNT_REMOTE_INVALID	Remote user account was not found on the IM server.
ERROR_ACCOUNT_REMOTE_DISABLED	Remote user account is disabled on the IM server.
ERROR_ACCOUNT_INVALID_MAY_CREATE_EMAIL	User account was not found on the IM server but it is possible to create account based on user's e-mail address from the IM client.
ERROR_ACCOUNT_MULTIPLE_LOGONS	Session with the IM server cannot be established because another session with the same user account is already active on remote computer.
ERROR_ACCOUNT_EXISTS	User account cannot be created from the IM client because it already exists on the IM server.
ERROR_GROUP_INVALID	Specified messaging group was not found on the IM server.
ERROR_GROUP_NOT_EXIST	Specified messaging group is not assigned to current user.
ERROR_GROUP_NO_PERMISSION	User has no permissions to send instant messages on specified messaging group.
ERROR_GROUP_DISABLED	Specified messaging group is disabled on the IM server.
ERROR_MESSAGE_SENT	Instant message was successfully sent.
ERROR_MESSAGE_SENT_OFFLINE	Instant message was successfully sent and stored as offline message on the IM server.
ERROR_CONTACTS_NOT_DEFINED	User's Contact List was not received from the IM server becuase the contacts are not organized yet.
ERROR_CONTACTS_OK	User's Contact List was successfully received from the IM server.
ERROR_CONTACTS_CHANGED	User's Contact List was successfully received from the IM server but the contacts has minor changes due to removal/deletion some users on the server.
ERROR_CONTACTS_NEEDS_TO_REBUILD	User's Contact List was not received from the IM server due to major changes in the users structure on the server. Contacts must be rebuilt by user.
ERROR_CONTACTS_ADDED	User's Contact List was successfully received from the IM server but new users can be added to the contacts.
ERROR_CONTACTS_REBUILT	User's Contact List was rebuilt on the IM server and successfully received by the client.
ERROR_CONNECTION_CLOSED_AS_EXISTING_ERROR	Connection with the IM server has been automatically closed because new user has entered to the IM network under the same user account.