LicenseException Class

.NET Framework (current version)

Other Versions

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

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

Inheritance Hierarchy

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

Syntax

C++

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

Constructors

	Name	Description
	LicenseException(SerializationInfo^, StreamingContext)	Initializes a new instance of the LicenseException class with the given SerializationInfo and StreamingContext.
	LicenseException(Type^)	Initializes a new instance of the LicenseException class for the type of component that was denied a license.
	LicenseException(Type^, Object^)	Initializes a new instance of the LicenseException class for the type and the instance of the component that was denied a license.
	LicenseException(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.
	LicenseException(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.

Properties

	Name	Description
	Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception.(Inherited from Exception.)
	HelpLink	Gets or sets a link to the help file associated with this exception.(Inherited from Exception.)
	HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.(Inherited from Exception.)
	InnerException	Gets the Exception instance that caused the current exception.(Inherited from Exception.)
	LicensedType	Gets the type of the component that was not granted a license.
	Message	Gets a message that describes the current exception.(Inherited from Exception.)
	Source	Gets or sets the name of the application or the object that causes the error.(Inherited from Exception.)
	StackTrace	Gets a string representation of the immediate frames on the call stack.(Inherited from Exception.)
	TargetSite	Gets the method that throws the current exception.(Inherited from Exception.)

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetBaseException()	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.(Inherited from Exception.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetObjectData(SerializationInfo^, StreamingContext)	Sets the SerializationInfo with information about the exception.(Overrides Exception::GetObjectData(SerializationInfo^, StreamingContext).)
	GetType()	Gets the runtime type of the current instance.(Inherited from Exception.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Creates and returns a string representation of the current exception.(Inherited from Exception.)

Events

	Name	Description
	SerializeObjectState	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.

Examples

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.

C++

try
{
   License^ licTest = nullptr;
   licTest = LicenseManager::Validate( Form1::typeid, this );
}
catch ( LicenseException^ licE ) 
{
   Console::WriteLine( licE->Message );
   Console::WriteLine( licE->LicensedType );
   Console::WriteLine( licE->StackTrace );
   Console::WriteLine( licE->Source );
}

Version Information

.NET Framework
Available since 1.1

Thread Safety

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