LicenseException Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Represents the exception thrown when a component cannot be granted a license.

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)

System.Object
  System.Exception
    System.SystemException
      System.ComponentModel.LicenseException

[SerializableAttribute]
[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public class LicenseException : SystemException

NameDescription
System_CAPS_protmethodLicenseException(SerializationInfo, StreamingContext)

Initializes a new instance of the LicenseException class with the given SerializationInfo and StreamingContext.

System_CAPS_pubmethodLicenseException(Type)

Initializes a new instance of the LicenseException class for the type of component that was denied a license.

System_CAPS_pubmethodLicenseException(Type, Object)

Initializes a new instance of the LicenseException class for the type and the instance of the component that was denied a license.

System_CAPS_pubmethodLicenseException(Type, Object, String)

Initializes a new instance of the LicenseException class for the type and the instance of the component that was denied a license, along with a message to display.

System_CAPS_pubmethodLicenseException(Type, Object, String, Exception)

Initializes a new instance of the LicenseException class for the type and the instance of the component that was denied a license, along with a message to display and the original exception thrown.

NameDescription
System_CAPS_pubpropertyData

Gets a collection of key/value pairs that provide additional user-defined information about the exception.(Inherited from Exception.)

System_CAPS_pubpropertyHelpLink

Gets or sets a link to the help file associated with this exception.(Inherited from Exception.)

System_CAPS_pubpropertyHResult

Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.(Inherited from Exception.)

System_CAPS_pubpropertyInnerException

Gets the Exception instance that caused the current exception.(Inherited from Exception.)

System_CAPS_pubpropertyLicensedType

Gets the type of the component that was not granted a license.

System_CAPS_pubpropertyMessage

Gets a message that describes the current exception.(Inherited from Exception.)

System_CAPS_pubpropertySource

Gets or sets the name of the application or the object that causes the error.(Inherited from Exception.)

System_CAPS_pubpropertyStackTrace

Gets a string representation of the immediate frames on the call stack.(Inherited from Exception.)

System_CAPS_pubpropertyTargetSite

Gets the method that throws the current exception.(Inherited from Exception.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetBaseException()

When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.(Inherited from Exception.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetObjectData(SerializationInfo, StreamingContext)

Sets the SerializationInfo with information about the exception.(Overrides Exception.GetObjectData(SerializationInfo, StreamingContext).)

System_CAPS_pubmethodGetType()

Gets the runtime type of the current instance.(Inherited from Exception.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Creates and returns a string representation of the current exception.(Inherited from Exception.)

NameDescription
System_CAPS_proteventSerializeObjectState

Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.(Inherited from Exception.)

The LicenseManager.Validate method throws LicenseException when a component cannot obtain a valid license. This occurs when a component is either not licensed, or is licensed but cannot be granted a valid license.

For more information on licensing, see How to: License Components and Controls.

The following code example shows how to catch a LicenseException and interpret its content. In the sample, the application calls the Validate method for a System.Windows.Forms.Form that is not licensed. Upon catching the exception, the sample fetches the respective error message, the type of component that was not granted a license, the stack trace, and the origin of the exception.

This example requires that you have specified the LicenseProvider by marking the System.Windows.Forms.Form with a LicenseProviderAttribute attribute. For more information on how to do this, see the LicenseManager class.

try {
    License licTest = null;
    licTest = LicenseManager.Validate(typeof(Form1), this);
}

catch(LicenseException licE) {
    Console.WriteLine(licE.Message);
    Console.WriteLine(licE.LicensedType);
    Console.WriteLine(licE.StackTrace);
    Console.WriteLine(licE.Source);	
}

.NET Framework
Available since 1.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: