Developer Zone

Common Return Values¶

Most methods return an enum value of type GenericReturn. This is used to show whether the method call was accepted and executed successfully.

OK (1)

A number of methods that do not need to return any specific value, return this value when they have been called successfully and without errors.

FunctionNotAvailable (-1)

This indicates that this particular API call is not currently available. Possible causes include:

  • This feature is disabled from the server side. If this is an optional feature you might need to turn it on from the Trackerbird Web UI inside the customer login area.
  • You have called this method too many times in quick succession from the same client. In order to prevent abuse the server might impose a minimum interval (time threshold) before you can call this method again. This interval can vary from seconds to minutes.

ConnectionError (-2)

This means there was a problem communicating with the Trackerbird server due to:

  • network connectivity problems
  • Incorrect proxy settings
  • HTTP traffic is blocked by a gateway or firewall

In some cases it might help testing the internet connection by calling the :cs:func:`TBApp.ConnectionCheck` method.

AuthenticationFailure (-3)

This is typically encountered when using a proxy with Authentication enabled. Make sure you are entering the correct proxy credentials using :cs:func:`TBConfig.SetProxy` or :cs:func:`TBConfig.SetDefaultProxyCredentials`.

ServerError (-4)

The server returned an error or specifically refused the connection. Causes:

  • You are using the wrong callhome URL
  • You are using the wrong product ID
  • Some temporary server error occured

Login to the Web UI to make sure your account is active and there are no critical warnings. Test using :cs:func:`TBApp.ConnectionCheck` method.

ConfigNotCreated (-5)

The method :cs:func:`TBConfig.CreateConfig` needs to be called before calling further configuration-related methods (Providing further data) or :cs:func:`TBApp.Start`. If this is not done, these functions would return ConfigNotCreated.

ConfigAlreadyCreated (-6)

If the method :cs:func:`TBConfig.CreateConfig` is called twice, on the second time, it would return this value. This means that this method should only be called once to initialize the configuration. If any value needs to be changed afterwards, this can be done by calling methods in the Providing further data section.

ConfigNotLoaded (-7)

This value is returned if :cs:func:`TBApp.Start` was not called or if it didn’t finish successfully. Methods that logically require an application to be started before they can run return this value if a call to :cs:func:`TBApp.Start` has not been done.

InvalidParameter (-9)

This value is returned in cases where an invalid parameter value has been passed. These include cases such as where a valid wchar_t* value is required, but a NULL is passed instead, or when trying to stop a session via :cs:func:`TBApp.SessionStop`, but the session ID that is passed does not exist (has not been started).