| Getting Started |
| Setup |
| Visual C++ Developer's Guide |
| Interfaces |
| IServerClient |
| Overview |
| IServerClient::CloseSession |
| IServerClient::CreateAccount |
| IServerClient::DeclineFile |
| IServerClient::EnumAvailableContacts |
| IServerClient::EnumContactList |
| IServerClient::EnumGroupContacts |
| IServerClient::EnumGroups |
| IServerClient::GetAccountInformation |
| IServerClient::GetAccountStatus |
| IServerClient::GetAvailableContacts |
| IServerClient::GetContactList |
| IServerClient::GetGroupContacts |
| IServerClient::GetGroups |
| IServerClient::GetEventDescription |
| IServerClient::GetLicenseInformation |
| IServerClient::GetSDKVersion |
| IServerClient::GetServerVersion |
| IServerClient::GetSessionKey |
| IServerClient::Initialize |
| IServerClient::ModifyAccount |
| IServerClient::OpenSession |
| IServerClient::ReceiveFile |
| IServerClient::SaveAccount |
| IServerClient::SendFile |
| IServerClient::SendFileRequest |
| IServerClient::SendMessage |
| IServerClient::SendMessageTypingEvent |
| IServerClient::SendMultipleMessage |
| IServerClient::SetAccountPassword |
| IServerClient::SetContactList |
| IServerClient::TestConnection |
| IServerClient::UpdateSession |
| IServerClient::ViewAccount |
| Structures |
| Overview |
| FILE_INFO_STRUCT |
| FILE_NAME |
| MULTIPLE_RECIPIENT_STRUCT |
| NOTIFY_FILE_STATUS_STRUCT |
| NOTIFY_FORWARD_ MULTIPLE_MESSAGE_STRUCT |
| NOTIFY_GROUPS_STRUCT |
| TRANSFER_ACCOUNT_STRUCT |
| TRANSFER_CONTACT_LIST_STRUCT |
| TRANSFER_CONTACT_STRUCT |
| TRANSFER_FILE_STRUCT |
| TRANSFER_GROUP_STRUCT |
| TRANSFER_MESSAGE_STRUCT |
| TRANSFER_MESSAGE_TYPING_EVENT_STRUCT |
| TRANSFER_MULTIPLE_MESSAGE_STRUCT |
| TRANSFER_NOTIFY_FILE_STRUCT |
| TRANSFER_NOTIFY_GROUP_STRUCT |
| TRANSFER_OU_STRUCT |
| TRANSFER_STATUS_STRUCT |
| Notifications |
| Overview |
| NOTIFY_ACCOUNT_PASSWORD_RESET |
| NOTIFY_CONTACT_STATUS |
| NOTIFY_CONTACTS_ADDED |
| NOTIFY_CONTACTS_CHANGED |
| NOTIFY_CONTACTS_NEEDS_TO_REBUILD |
| NOTIFY_CONTACTS_REBUILT |
| NOTIFY_FILE_STATUS |
| NOTIFY_FORWARD_MESSAGE |
| NOTIFY_FORWARD_MULTIPLE_MESSAGE |
| NOTIFY_GROUP_ADDED |
| NOTIFY_GROUP_ADDED_BY_USER |
| NOTIFY_GROUP_CHANGED |
| NOTIFY_GROUP_CHANGED_BY_USER |
| NOTIFY_GROUP_REMOVED |
| NOTIFY_GROUP_REMOVED_BY_USER |
| NOTIFY_MESSAGE_TYPING_EVENT |
| NOTIFY_NEW_MESSAGE |
| NOTIFY_NEW_TRANSFER |
| NOTIFY_SESSION_CLOSED |
| NOTIFY_SESSION_CLOSED_AS_EXISTING |
| NOTIFY_SESSION_PINGPONG |
| Available Extended Codes |
| VB.NET Developer's Guide |
| Interfaces |
| IServerClientVB |
| Overview |
| IServerClientVB::CloseSession |
| IServerClientVB::CreateAccount |
| IServerClientVB::EnumAvailableContacts |
| IServerClientVB::EnumContactList |
| IServerClientVB::EnumGroupContacts |
| IServerClientVB::EnumGroups |
| IServerClientVB::GetAccountInformation |
| IServerClientVB::GetAccountStatus |
| IServerClientVB::GetAvailableContacts |
| IServerClientVB::GetContactList |
| IServerClientVB::GetGroupContacts |
| IServerClientVB::GetGroups |
| IServerClientVB::GetEventDescription |
| IServerClientVB::GetLicenseInformation |
| IServerClientVB::GetSDKVersion |
| IServerClientVB::GetServerVersion |
| IServerClientVB::GetSessionKey |
| IServerClientVB::Initialize |
| IServerClientVB::ModifyAccount |
| IServerClientVB::OpenSession |
| IServerClientVB::SaveAccount |
| IServerClientVB::SendMessage |
| IServerClientVB::SendMessageTypingEvent |
| IServerClientVB::SendMultipleMessage |
| IServerClientVB::SetAccountPassword |
| IServerClientVB::SetContactList |
| IServerClientVB::TestConnection |
| IServerClientVB::UpdateSession |
| IServerClientVB::ViewAccount |
| Structures |
| Overview |
| VBAccountStruct |
| VBContactListStruct |
| VBContactStruct |
| VBGroupStruct |
| VBMessageStruct |
| VBMessageTypingStruct |
| VBMultipleMessageStruct |
| VBNotifyGroupStruct |
| VBOuStruct |
| VBRecipientStruct |
| VBStatusStruct |
| Notifications |
| Overview |
| AccountPasswordReset |
| ContactStatus |
| ContactListAdded |
| ContactListChanged |
| ContactListNeedsToBeRebuilt |
| ContactListRebuilt |
| GroupAdded |
| GroupChanged |
| GroupRemoved |
| MessageTypingEvent |
| NewMessage |
| SessionClosed |
| SessionClosedAsExisting |
| SessionPingPong |
| Available Extended Codes |
| MS Office (VBA) Developer's Guide |
| Interfaces |
| IServerClientVBA |
| Overview |
| IServerClientVBA::CloseSession |
| IServerClientVBA::CreateAccount |
| IServerClientVBA::EnumAvailableContacts |
| IServerClientVBA::EnumContactList |
| IServerClientVBA::EnumGroupContacts |
| IServerClientVBA::EnumGroups |
| IServerClientVBA::GetAccountInformation |
| IServerClientVBA::GetAccountStatus |
| IServerClientVBA::GetAvailableContacts |
| IServerClientVBA::GetContactList |
| IServerClientVBA::GetEventDescription |
| IServerClientVBA::GetGroupContacts |
| IServerClientVBA::GetGroups |
| IServerClientVBA::GetLicenseInformation |
| IServerClientVBA::GetSDKVersion |
| IServerClientVBA::GetServerVersion |
| IServerClientVBA::GetSessionKey |
| IServerClientVBA::Initialize |
| IServerClientVBA::ModifyAccount |
| IServerClientVBA::OpenSession |
| IServerClientVBA::SaveAccount |
| IServerClientVBA::SendMessage |
| IServerClientVBA::SendMessageTypingEvent |
| IServerClientVBA::SendMultipleMessage |
| IServerClientVBA::SetAccountPassword |
| IServerClientVBA::SetContactList |
| IServerClientVBA::TestConnection |
| IServerClientVBA::UpdateSession |
| IServerClientVBA::ViewAccount |
| Types |
| Overview |
| AccountStruct |
| ContactListStruct |
| ContactStruct |
| GroupStruct |
| MessageStruct |
| MessageTypingStruct |
| MultipleMessageStruct |
| NotifyGroupStruct |
| OuStruct |
| RecipientStruct |
| StatusStruct |
| Notifications |
| Overview |
| AccountPasswordReset |
| ContactListAdded |
| ContactListChanged |
| ContactListNeedsToBeRebuilt |
| ContactListRebuilt |
| ContactStatus |
| GroupAdded |
| GroupChanged |
| GroupRemoved |
| MessageTypingEvent |
| NewMessage |
| SessionClosed |
| SessionClosedAsExisting |
| SessionPingPong |
| Available Extended Codes |
| About |
The error codes provided in the table below returned in the ReturnCode parameter by functions of the IServerClientVB interface. To get a description for the error code on run-time use the IServerClientVB::GetEventDescription function.
The constants below are defined within VBResultCode enum defined in the CSCLIENTLib workspace.
List of Event Codes
| SUCCESS | Operation is successful |
| TIMEOUT_EXPIRED | Operation timeout was expired. Try to perform the operation again. |
| UNKNOWN_ERROR | Unknown error returned. Try to perform the operation again. |
| SQL_ERROR | SQL error was occurred on the IM server. Try to perform the operation again. |
| SECURE_ERROR | Encryption error was returned by the client module or by the IM server. Try to perform the operation again. |
| INTERNAL_ERROR | Unknown internal error occurred on the client or on the IM server. Try to perform the operation again. |
| CANNOT_CONNECT | The IM server is not found or is not running. Check the server address and try to connect to the server again. |
| SEND_ERROR | Network error occurred while sending the data. Try to perform the operation again. |
| RECEIVE_ERROR | Network error occurred while receiving the data. Try to perform the operation again. |
| PROTOCOL_ERROR | Current protocol version on the client is not compatible with the IM server. Update the client or the IM server software. |
| CANNOT_START | Error occurred while initializing internal message loop on the IM client. |
| CONNECTION_LIMIT_ERROR | Current connection cannot be accepted by the IM server because it's software license does not support such number of concurrent users. |
| LICENSE_EXPIRED_ERROR | The software license on the IM server expired. |
| PACKAGE_UPDATE | An update for the client software will be sent from the IM server. |
| SERVER_BUSY | The IM server is currently busy and it cannot accept the request at this time. Try to perform the operation again. |
| AUTHENTICATION_ERROR | Authentication error. Check the user name and password. |
| AUTHENTICATION_WINDOWS | Authorization via Windows Authentication is required to connect to the IM server. |
| AUTHENTICATION_PASSWORD | Authorization via login and password is required to connect to the IM server. |
| AUTHENTICATION_SIMPLE | Simple authentication is required to connect to the IM server. |
| INVALID_PARAM_ERROR | Invalid parameters are passed to the function. |
| NOT_CONNECTED_ERROR | The IM client is not currently connected to the IM server to perform the request. |
| ALREADY_CONNECTED_ERROR | The IM client is already connected to the IM server |
| NOT_SUPPORTED_ERROR | The IM client does not support the request. |
| SESSION_INVALID | Current session with the IM server is invalid. Disconnect and connect to the IM server again. |
| ACCOUNT_INVALID | User account was not found on the IM server. |
| ACCOUNT_INVALID_MAY_CREATE | User account was not found on the IM server but it is possible to create account from the IM client. |
| ACCOUNT_DISABLED | User account is disabled on the IM server. |
| ACCOUNT_READONLY | User account is set as read-only on the IM server and cannot be changed by the user. |
| ACCOUNT_REMOTE_INVALID | Remote user account was not found on the IM server. |
| ACCOUNT_REMOTE_DISABLED | Remote user account is disabled on the IM server. |
| 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. |
| 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. |
| ACCOUNT_EXISTS | User account cannot be created from the IM client because it already exists on the IM server. |
| GROUP_INVALID | Specified messaging group was not found on the IM server. |
| GROUP_NOT_EXIST | Specified messaging group is not assigned to current user. |
| GROUP_NO_PERMISSION | User has no permissions to send instant messages on specified messaging group. |
| GROUP_DISABLED | Specified messaging group is disabled on the IM server. |
| MESSAGE_SENT | Instant message was successfully sent. |
| MESSAGE_SENT_OFFLINE | Instant message was successfully sent and stored as offline message on the IM server. |
| CONTACTS_NOT_DEFINED | User's Contact List was not received from the IM server becuase the contacts are not organized yet. |
| CONTACTS_OK | User's Contact List was successfully received from the IM server. |
| 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. |
| 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. |
| CONTACTS_ADDED | User's Contact List was successfully received from the IM server but new users can be added to the contacts. |
| CONTACTS_REBUILT | User's Contact List was rebuilt on the IM server and successfully received by the client. |
| 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. |