FChoice.Common Namespace

The FChoice.Common namespace provides configuration, logging, and error management services to First Choice .NET-based products.

Classes

  Class Description
Class CommonException CommonException is the exception class used throughout the FChoice.Common and FChoice.Common.Data namespaces. It provides localized error messages with unique error identifiers.
Class ConfigValues ConfigValues is a collection of string constants used for strongly-typing the keys used to access the common configuration items in the FCConfiguration collection.
Class DataProtector Provides easy access to the Windows Data Protection API (DPAPI) for encrypting and decrypting data values
Class FCArgumentException FCArgumentException is used to signify that parameters passed into APIs are invalid. It has several static (Shared in Visual Basic) methods that make handling required parameters easier.
Class FCConfiguration The FCConfiguration class provides access to the application configuration and ensures that basic required configuration parameters are present.
Class FCExceptionBase FCExceptionBase is the base exception from which all other First Choice exception classes derive. It provides pluggable error message strings which allows for easy runtime customization and localization of error messages.
Class FCInvalidConfigurationException FCInvalidConfigurationException is used when required parameters are missing from the application configuration file, or the parameters specified are invalid for some reason.
Class FCLicenseException FCLicenseException is used when a licensed product attempts to obtain a license key from the installed set of keys and either cannot find its key or an error occurs retreiving the list of licenses.
Class InvalidLoggingConfigException  
Class Logger Logger is used by classes throughout First Choice .NET-based products to write logging entries.
Class LogManager LogManager provides access to the logging subsystem so that classes and write log entries and allow those entries to be processed according to the application logging configuration.
Class PerfManager Provides basic convenience services for instrumenting performance counters in an application
Class StringUtil  

Interfaces

  Interface Description
Interface IErrorMessageProvider The IErrorMessageProvider is the interface used by FCExceptionBase to allow other assemblies to provide custom error message resolution.

Enumerations

  Enumeration Description
Enumeration DataProtectionStore DataProtectionStore is used with the DataProtector when encrypting or decrypting data. DataProtectionStore tells the DataProtector which key store to use.
Enumeration FCLicenseException.LoadFailReasons LoadFailReasons is used by FCLicenseException to provide a specific reason why license procurement failed for the product.
Enumeration LogLevel LogLevel is an enumeration of supported logging levels. This is used in conjunction with LogManager and Logger to control how log messages are filtered or written to the output appender.

Remarks

The FChoice.Common namespace is largely intended to be used by First Choice .NET products only. While public for your convenience, usage of any of these classes directly (except for Configuration or Logging) is discouraged.

Reference

FChoice.Common Assembly