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 |
Initializes the IServerClientVBA class and puts necessary variables used by the object. This method must be called before calls of all other methods of the IServerClientVBA interface.
Public Sub Initialize( ByRef ServerAddress As String, ByRef ServerPort As Integer, ByRef Client As ClientType, ByRef WindowHandlePtr As Long, ByRef ResultCode As Long )
Parameters
- ServerAddress
- [in]
String
variable that contains the name or address of the IM server. The address can be IP address or DNS name of a computer.- ServerPort
- [in]
Integer
variable that specifies TCP/IP port on the IM server to connect to. Set this parameter to0
value to use default port.- Client
- [in] Type of the messaging client. Depending on this parameter the IM server performs or does not some operations, data delivery, etc. This parameter can be one of the following values:
ClientType.ClientType_Full
- Indicates a full-featured client which can send and receive instant messages, operate with contacts, groups, etc.
ClientType.ClientType_Oneway
- Indicates a one-way messenger client that can only receive messages. Operations with contacts and groups are not allowed.
- WindowHandlePtr
- [in] A pointer to a handle of the window that should receive all notifications and messages sent from the IM server.
- ResultCode
- [out] Variable of
Long
type that gets an extended code if error result is returned. For available codes see Available Extended Codes topic.
Return Value
S_OK
- The function was successful.
E_INVALIDARG
- One or more arguments are incorrect.
E_FAIL
- Some error occurred in the function. Check ResultCode variable to get extended information on the error.