LicenseInfo

Class used to authenticate a user or commercial license with Indx. Access through engine.Status.LicenseInfo.

Load a .license file via the SearchEngine constructor:

csharp
var engine = new SearchEngine("filename.license");

var license = engine.Status.LicenseInfo;
Console.WriteLine(
quot;Licensed: {license.Licensed}"); Console.WriteLine(
quot;Licensed to: {license.LicensedTo}"); Console.WriteLine(
quot;Document limit: {license.DocumentLimit}");

Properties

PropertyTypeDescription
LicenseFileName
string
Filename of the loaded .license file
Licensed
bool
True if a correct .license file has been loaded
ValidLicense
bool
True if all parameters are within specification
Type
string
License type: developer, commercial, or other
Description
string
Information about the loaded license
LicensedTo
string
Name of the license holder
DocumentLimit
int
Maximum number of documents allowed. Without a license: 100,000
DocumentLimitExceeded
bool
True if more documents are loaded than the license permits
ExpirationDate
DateTime
Date when the license expires

License Tiers

TierDocument LimitCost
No license
100,000
Free
Extended license
Unlimited
Free — register at indx.co
Company license
Unlimited + SLA
Paid

Constructors

csharp
LicenseInfo()

Empty ctor required for JSON serializer.

Properties

NameTypeAccessDescription
Description
string
get/set
Gets the description of the license.
DocumentLimit
int
get/set
Gets the maximum number of documents allowed by the license.
DocumentLimitExceeded
bool
get/set
Gets a value indicating whether the document limit has been exceeded.
ExpirationDate
DateTime
get/set
Gets the expiration date of the license.
LicenseFileFound
bool
get/set
Gets a value indicating whether a license file was found at the specified path. This is true even if the license has expired or is otherwise invalid. Use this to distinguish "no file present" from "file present but not valid".
Licensed
bool
get/set
Gets a value indicating whether the application is licensed.
LicensedTo
string
get/set
Gets the name of the license holder. Person or company.
LicenseFileName
string
get/set
Gets or sets the file name of the license.
Type
string
get/set
Gets the type of the license.
ValidLicense
bool
get/set
Gets a value indicating whether the license is valid.

Methods

GetLicenseInfo

csharp
static LicenseInfo GetLicenseInfo(string licenseFileNameAndPath, Boolean& isObfuscated)
  • string licenseFileNameAndPath
  • Boolean& isObfuscated

Returns: LicenseInfo