Click or drag to resize

StreetSmartLoginFailedException Class

This exception is thrown when loggin fails.
Inheritance Hierarchy
SystemObject
  SystemException
    StreetSmart.Common.ExceptionsStreetSmartLoginFailedException

Namespace: StreetSmart.Common.Exceptions
Assembly: StreetSmart.WinForms (in StreetSmart.WinForms.dll) Version: 23.9.0.0 (23.9.0.0)
Syntax
public class StreetSmartLoginFailedException : Exception

The StreetSmartLoginFailedException type exposes the following members.

Properties
 NameDescription
Public propertyDataGets a collection of key/value pairs that provide additional user-defined information about the exception.
(Inherited from Exception)
Public propertyHelpLinkGets or sets a link to the help file associated with this exception.
(Inherited from Exception)
Public propertyHResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception.
(Inherited from Exception)
Public propertyInnerExceptionGets the Exception instance that caused the current exception.
(Inherited from Exception)
Public propertyMessageGets a message that describes the current exception.
(Inherited from Exception)
Public propertySourceGets or sets the name of the application or the object that causes the error.
(Inherited from Exception)
Public propertyStackTraceGets a string representation of the immediate frames on the call stack.
(Inherited from Exception)
Public propertyTargetSiteGets the method that throws the current exception.
(Inherited from Exception)
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetBaseExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
(Inherited from Exception)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetObjectDataWhen overridden in a derived class, sets the SerializationInfo with information about the exception.
(Inherited from Exception)
Public methodGetTypeGets the runtime type of the current instance.
(Inherited from Exception)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToStringCreates and returns a string representation of the current exception.
(Inherited from Exception)
Top
Events
 NameDescription
Protected eventSerializeObjectStateOccurs when an exception is serialized to create an exception state object that contains serialized data about the exception.
(Inherited from Exception)
Top
Example
This sample shows how to use the StreetSmartLoginFailedException Exception.
C#
using System;
using StreetSmart.Common.Exceptions;
using StreetSmart.Common.Factories;
using StreetSmart.Common.Interfaces;

namespace Demo
{
  public class Example
  {
    private IStreetSmartAPI _api;
    private System.Windows.Forms.Panel plStreetSmart = new System.Windows.Forms.Panel();

    public void StartAPI()
    {
      _api = StreetSmartAPIFactory.Create();
      _api.APIReady += OnAPIReady;
      plStreetSmart.Controls.Add(_api.GUI);
    }

    private async void OnAPIReady(object sender, EventArgs args)
    {
      // The dom element within the api must be rendered.
      IDomElement element = DomElementFactory.Create();

      // The initialisation options of the api.
      IOptions options = OptionsFactory.Create("myUsername", "myPassword", "myAPIKey", "EPSG:28992", element);

      try
      {
        // Initialize the api.
        await _api.Init(options);
        // Todo: add functionality
      }
      catch (StreetSmartLoginFailedException ex)
      {
        // login failed exception (ex)
      }
    }
  }
}

Version Information

Supported in: 18.7
See Also