STK X Send comments on this topic.
GetLicensingReport Method (AgSTKXApplication)
See Also  Example
Windows






Windows & Linux

Description

Returns a formatted string that contains the license names and their states. The string is formatted as an XML document.

Syntax

[Visual Basic .NET]
Public Function GetLicensingReport() As String

[C#]
public string GetLicensingReport();

[Managed C++]
public: String __gc ^ GetLicensingReport();

[Java]
public String getLicensingReport();

[Unmanaged C++]
public: HRESULT GetLicensingReport(
BSTR * ReturnValue
);

Return Type

Returns an XML string describing the available licenses.

Remarks

This method is available for debugging/tech support purposes. You should not need to use this unless troubleshooting a problem.

Example

Get the license configuration XML document and write it to a file.
[Visual Basic .NET] Copy Code
Dim stkx As AGI.STKX.AgSTKXApplication
Dim oType As Type = Type.GetTypeFromProgID("STKX11.Application")
stkx = Activator.CreateInstance(oType)

Dim lic As String
lic = stkx.GetLicensingReport()

Dim fs As FileStream = File.Open("C:\\Lic.xml", _
                                FileMode.Create, _
                                FileAccess.Write)
Dim info As Byte() = New UTF8Encoding(True).GetBytes(lic)
fs.Write(info, 0, info.Length)
fs.Close()

MessageBox.Show("Created C:\Lic.xml")

See Also

© 2017 Analytical Graphics, Inc. All Rights Reserved.

STK 11.2.1 Programming Interface