TeamTalk 4 .NET DLL  Version 4.5A
Client Error Handling

There are two types errors which can occur in the client, either server command error or internal errors. Section Client/Server Commands describes all the commands a client can issue to a server. If a server commands fails the client instance notifies the user application through the event TeamTalk4.OnCmdError(). An example of a server command error could be to issue the TeamTalk4.DoLogin() command with an incorrect server password. The server will in this case respond with the error ClientError CMDERR_INCORRECT_SERVER_PASSWORD. The user application must be designed to process these errors so application users can be notified of errors. More...

Enumerations

enum  BearWare.ClientError : uint {
  BearWare.SUCCESS = 0, BearWare.CMDERR_SYNTAX_ERROR = 1000, BearWare.CMDERR_UNKNOWN_COMMAND = 1001, BearWare.CMDERR_MISSING_PARAMETER = 1002,
  BearWare.CMDERR_INCOMPATIBLE_PROTOCOLS = 1003, BearWare.CMDERR_UNKNOWN_AUDIOCODEC = 1004, BearWare.CMDERR_INCORRECT_SERVER_PASSWORD = 2000, BearWare.CMDERR_INCORRECT_CHANNEL_PASSWORD = 2001,
  BearWare.CMDERR_INVALID_ACCOUNT = 2002, BearWare.CMDERR_MAX_SERVER_USERS_EXCEEDED = 2003, BearWare.CMDERR_MAX_CHANNEL_USERS_EXCEEDED = 2004, BearWare.CMDERR_SERVER_BANNED = 2005,
  BearWare.CMDERR_NOT_AUTHORIZED = 2006, BearWare.CMDERR_CANNOT_CREATE_CHANNELS = 2007, BearWare.CMDERR_MAX_DISKUSAGE_EXCEEDED = 2008, BearWare.CMDERR_SUBSCRIPTIONS_DISABLED = 2009,
  BearWare.CMDERR_INCORRECT_OP_PASSWORD = 2010, BearWare.CMDERR_AUDIOCODEC_BITRATE_LIMIT_EXCEEDED = 2011, BearWare.CMDERR_MAX_LOGINS_PER_IPADDRESS_EXCEEDED = 2012, BearWare.CMDERR_NOT_LOGGEDIN = 3000,
  BearWare.CMDERR_ALREADY_LOGGEDIN = 3001, BearWare.CMDERR_NOT_IN_CHANNEL = 3002, BearWare.CMDERR_ALREADY_IN_CHANNEL = 3003, BearWare.CMDERR_CHANNEL_ALREADY_EXISTS = 3004,
  BearWare.CMDERR_CHANNEL_NOT_FOUND = 3005, BearWare.CMDERR_USER_NOT_FOUND = 3006, BearWare.CMDERR_BAN_NOT_FOUND = 3007, BearWare.CMDERR_FILETRANSFER_NOT_FOUND = 3008,
  BearWare.CMDERR_OPENFILE_FAILED = 3009, BearWare.CMDERR_ACCOUNT_NOT_FOUND = 3010, BearWare.CMDERR_FILE_NOT_FOUND = 3011, BearWare.CMDERR_FILE_ALREADY_EXISTS = 3012,
  BearWare.CMDERR_FILESHARING_DISABLED = 3013, BearWare.CMDERR_SERVER_HAS_USERS = 3014, BearWare.CMDERR_CHANNEL_HAS_USERS = 3015, BearWare.INTERR_SNDINPUT_FAILURE = 10000,
  BearWare.INTERR_SNDOUTPUT_FAILURE = 10001
}
 Errors which can occur either as a result of client commands or as a result of internal errors. More...
 

Functions

static string BearWare.TeamTalk4.GetErrorMessage (ClientError nError)
 Get textual discription of an error message. More...
 

Detailed Description

There are two types errors which can occur in the client, either server command error or internal errors. Section Client/Server Commands describes all the commands a client can issue to a server. If a server commands fails the client instance notifies the user application through the event TeamTalk4.OnCmdError(). An example of a server command error could be to issue the TeamTalk4.DoLogin() command with an incorrect server password. The server will in this case respond with the error ClientError CMDERR_INCORRECT_SERVER_PASSWORD. The user application must be designed to process these errors so application users can be notified of errors.

Internal errors are errors due to failing devices. Currently only two such errors exist ClientError INTERR_SNDINPUT_FAILURE and ClientError INTERR_SNDOUTPUT_FAILURE.

Enumeration Type Documentation

enum BearWare.ClientError : uint

Errors which can occur either as a result of client commands or as a result of internal errors.

Use TeamTalk4.GetErrorMessage() to get a text-description of the error.

Enumerator
SUCCESS 

Command indicating success. Only used internally.

CMDERR_SYNTAX_ERROR 

Command has syntax error. Only used internally.

CMDERR_UNKNOWN_COMMAND 

The server doesn't support the issued command.

This error may occur if the server is an older version than the client instance.

CMDERR_MISSING_PARAMETER 

Command cannot be performed due to missing parameter. Only used internally.

CMDERR_INCOMPATIBLE_PROTOCOLS 

The server uses a protocol which is incompatible with the client instance.

CMDERR_UNKNOWN_AUDIOCODEC 

The server does not support the audio codec specified by the client. Introduced in version 4.1.0.1264.

See Also
TeamTalk4.DoMakeChannel()
TeamTalk4.DoJoinChannel()
CMDERR_INCORRECT_SERVER_PASSWORD 

Invalid server password.

The TeamTalk4.DoLogin() command passed a server password which was invalid.

See Also
TeamTalk4.DoLogin
CMDERR_INCORRECT_CHANNEL_PASSWORD 

Invalid channel password.

The TeamTalk4.DoJoinChannel() or TeamTalk4.DoJoinChannel()ByID passed an invalid channel password. TeamTalk4.DoMakeChannel() can also cause a this error if the password is longer than BearWare.TeamTalk4.TT_STRLEN.

CMDERR_INVALID_ACCOUNT 

Invalid username or password for account.

The TeamTalk4.DoLogin() command was issued with invalid account properties. This error can also occur by TeamTalk4.DoNewUserAccount() if username is empty.

CMDERR_MAX_SERVER_USERS_EXCEEDED 

Login failed due to maximum number of users on server.

TeamTalk4.DoLogin() failed because the server does not allow any more users.

CMDERR_MAX_CHANNEL_USERS_EXCEEDED 

Cannot join channel because it has maximum number of users.

TeamTalk4.DoJoinChannel() or TeamTalk4.DoJoinChannel()ByID failed because no more users are allowed in the channel.

CMDERR_SERVER_BANNED 

IP-address has been banned from server.

TeamTalk4.DoLogin() failed because the local client's IP-address has been banned on the server.

CMDERR_NOT_AUTHORIZED 

Command not authorized.

   The command cannot be performed because the client instance
   has insufficient rights.
See Also
TeamTalk4.DoDeleteFile
TeamTalk4.DoJoinChannel
TeamTalk4.DoJoinChannelByID
TeamTalk4.DoLeaveChannel
TeamTalk4.DoChannelOp
TeamTalk4.DoChannelOpEx
TeamTalk4.DoKickUser
TeamTalk4.DoUpdateChannel
TeamTalk4.DoChangeNickname
TeamTalk4.DoChangeStatus
TeamTalk4.DoTextMessage
TeamTalk4.DoSubscribe
TeamTalk4.DoUnsubscribe
TeamTalk4.DoMakeChannel
TeamTalk4.DoRemoveChannel
TeamTalk4.DoMoveUser
TeamTalk4.DoUpdateServer
TeamTalk4.DoSaveConfig
TeamTalk4.DoSendFile
TeamTalk4.DoRecvFile
TeamTalk4.DoBanUser
TeamTalk4.DoUnBanUser
TeamTalk4.DoListBans
TeamTalk4.DoListUserAccounts
TeamTalk4.DoNewUserAccount
TeamTalk4.DoDeleteUserAccount
CMDERR_CANNOT_CREATE_CHANNELS 

Server doesn't allow users to create channels.

   TeamTalk4.DoJoinChannel() or TeamTalk4.DoJoinChannel()ByID failed because
   #UserRight ::USERRIGHT_CHANNEL_CREATION is not enabled.  
See Also
ServerProperties
CMDERR_MAX_DISKUSAGE_EXCEEDED 

Cannot upload file because disk quota will be exceeded.

   TeamTalk4.DoSendFile() was not allowed because there's not enough
   disk space available for upload.
See Also
Channel
CMDERR_SUBSCRIPTIONS_DISABLED 

Modifying subscriptions not enabled.

   TeamTalk4.DoSubscribe() or TeamTalk4.DoUnsubscribe() failed because the
   server does not allow users to change subscriptions. The
   #UserRight ::USERRIGHT_SUBSCRIPTIONS is not enabled in the server's
   #BearWare.ServerProperties.
See Also
ServerProperties
CMDERR_INCORRECT_OP_PASSWORD 

Invalid password for becoming channel operator.

The password specified in TeamTalk4.DoChannelOpEx() is not correct. The operator password is the szOpPassword of the BearWare.Channel-struct.

CMDERR_AUDIOCODEC_BITRATE_LIMIT_EXCEEDED 

The selected BearWare.AudioCodec exceeds what the server allows.

A server can limit the vitrate of audio codecs if nAudioCodecBpsLimit of BearWare.ServerProperties is specified.

CMDERR_MAX_LOGINS_PER_IPADDRESS_EXCEEDED 

The maximum number of logins allowed per IP-address has been exceeded.

See Also
ServerProperties
TeamTalk4.DoLogin()
CMDERR_NOT_LOGGEDIN 

Client instance has not been authenticated.

TeamTalk4.DoLogin() has not been issued successfully or TeamTalk4.DoLogout() could not be performed because client instance is already logged in.

CMDERR_ALREADY_LOGGEDIN 

Already logged in.

TeamTalk4.DoLogin() cannot be performed twice.

CMDERR_NOT_IN_CHANNEL 

Cannot leave channel because not in channel.

TeamTalk4.DoLeaveChannel() failed because user is not in a channel.

CMDERR_ALREADY_IN_CHANNEL 

Cannot join same channel twice.

TeamTalk4.DoJoinChannel() or TeamTalk4.DoJoinChannel()ByID failed because client instance is already in the specified channel.

CMDERR_CHANNEL_ALREADY_EXISTS 

Channel already exists.

TeamTalk4.DoMakeChannel() failed because channel already exists.

CMDERR_CHANNEL_NOT_FOUND 

Channel does not exist.

   Command failed because channel does not exists.
See Also
TeamTalk4.DoRemoveChannel
TeamTalk4.DoUpdateChannel
TeamTalk4.DoMakeChannel Due to invalid channel name
TeamTalk4.DoSendFile
TeamTalk4.DoRecvFile
TeamTalk4.DoDeleteFile
TeamTalk4.DoJoinChannel
TeamTalk4.DoJoinChannelByID
TeamTalk4.DoLeaveChannel
TeamTalk4.DoChannelOp
TeamTalk4.DoKickUser
TeamTalk4.DoBanUser
TeamTalk4.DoMoveUser
TeamTalk4.DoTextMessage
CMDERR_USER_NOT_FOUND 

User not found.

   Command failed because user does not exists.
See Also
TeamTalk4.DoChannelOp
TeamTalk4.DoKickUser
TeamTalk4.DoBanUser
TeamTalk4.DoMoveUser
TeamTalk4.DoTextMessage
TeamTalk4.DoSubscribe
TeamTalk4.DoUnsubscribe
CMDERR_BAN_NOT_FOUND 

Banned IP-address does not exist.

TeamTalk4.DoUnBanUser() failed because there is no banned IP-address which matches what was specified.

CMDERR_FILETRANSFER_NOT_FOUND 

File transfer doesn't exists.

TeamTalk4.DoSendFile() or TeamTalk4.DoRecvFile() failed because the server cannot process the file transfer.

CMDERR_OPENFILE_FAILED 

Server failed to open file.

TeamTalk4.DoSendFile() or TeamTalk4.DoRecvFile() failed because the server cannot open the specified file (possible file lock).

CMDERR_ACCOUNT_NOT_FOUND 

Cannot find user account.

TeamTalk4.DoDeleteUserAccount() failed because the specified user account does not exists.

CMDERR_FILE_NOT_FOUND 

File does not exist.

TeamTalk4.DoSendFile(), TeamTalk4.DoRecvFile() or TeamTalk4.DoDeleteFile() failed because the server cannot find the specified file.

CMDERR_FILE_ALREADY_EXISTS 

File already exist.

TeamTalk4.DoSendFile() failed because the file already exists in the channel.

CMDERR_FILESHARING_DISABLED 

Server does not allow file transfers.

TeamTalk4.DoSendFile() or TeamTalk4.DoRecvFile() failed because the server does not allow file transfers.

CMDERR_SERVER_HAS_USERS 

Cannot process command since server is not empty.

See Also
TeamTalk4.DoUpdateServer() Ensure not to update UserRight USERRIGHT_VIEW_ALL_USERS.
CMDERR_CHANNEL_HAS_USERS 

Cannot process command since channel is not empty.

See Also
TeamTalk4.DoUpdateChannel() BearWare.AudioCodec cannot be changed while there are User Properties in a channel.
INTERR_SNDINPUT_FAILURE 

A sound input device failed.

This can e.g. happen when joining a channel and the sound device has been unplugged.

INTERR_SNDOUTPUT_FAILURE 

A sound output device failed.

This can e.g. happen when joining a channel and the sound device has been unplugged.

Function Documentation

static string BearWare.TeamTalk4.GetErrorMessage ( ClientError  nError)
static

Get textual discription of an error message.

Get a description of an error code posted by either OnCmdError or OnInternalError.

Parameters
nErrorThe number of the error.
Returns
A text description of the error.
See Also
OnCmdError
OnInternalError