Runtime.Initialize Methods

Initializes the Carmenta Engine runtime environment.

Overload List

	Name	Description
Public method	Initialize()	Initializes the Carmenta Engine runtime environment using the installed SDK license key.
Public method	Initialize(System.Boolean verifyThreadAccess)	Initializes the Carmenta Engine runtime environment using the installed SDK license key and optional thread verification.
Public method	Initialize(System.String licenseKey)	Initializes the Carmenta Engine runtime environment with the given license key.
Public method	Initialize(System.String licenseKey, System.Boolean verifyThreadAccess)	Initializes the Carmenta Engine runtime environment with the given license key.

Initialize()

Initializes the Carmenta Engine runtime environment using the installed SDK license key.

Syntax

public static void Initialize ()

Remarks

Note that this method will not work in a deployed application intended to use a Runtime license. See Initialize for the constructor that takes a license key as a parameter. More information on how the Carmenta Engine license system works can be found here Carmenta Engine 5 Runtime Licenses.

This constructor activates the Thread Access Verifier.

Initialize(System.Boolean verifyThreadAccess)

Initializes the Carmenta Engine runtime environment using the installed SDK license key and optional thread verification.

Syntax

public static void Initialize (
    System.Boolean verifyThreadAccess
)

Parameters

verifyThreadAccess

Type: System.Boolean
True to enable the thread access verifier; otherwise, False.

Remarks

Initialize(System.String licenseKey)

Initializes the Carmenta Engine runtime environment with the given license key.

Syntax

public static void Initialize (
    System.String licenseKey
)

Parameters

licenseKey

Type: System.String
A Carmenta Engine license key. String containing the XML document with the license information.

Remarks

More information on how the Carmenta Engine license system works can be found here Carmenta Engine 5 Runtime Licenses.

This constructor activates the Thread Access Verifier.

Initialize(System.String licenseKey, System.Boolean verifyThreadAccess)

Initializes the Carmenta Engine runtime environment with the given license key.

Syntax

public static void Initialize (
    System.String licenseKey,
    System.Boolean verifyThreadAccess
)

Parameters

licenseKey

Type: System.String
A Carmenta Engine license key. String containing the XML document with the license information.

verifyThreadAccess

Type: System.Boolean
True to enable the thread access verifier; otherwise, False.

Remarks

More information on how the Carmenta Engine license system works can be found here Carmenta Engine 5 Runtime Licenses.

Platforms

Windows, Linux, Android

Runtime::initialize Methods

Initializes the Carmenta Engine runtime environment.

Overload List

	Name	Description
Public method	initialize()	Initializes the Carmenta Engine runtime environment using the installed SDK license key.
Public method	initialize(bool verifyThreadAccess)	Initializes the Carmenta Engine runtime environment using the installed SDK license key and optional thread verification.
Public method	initialize(const char* licenseKey)	Initializes the Carmenta Engine runtime environment with the given license key.
Public method	initialize(const char* licenseKey, bool verifyThreadAccess)	Initializes the Carmenta Engine runtime environment with the given license key.

initialize()

Initializes the Carmenta Engine runtime environment using the installed SDK license key.

Syntax

C++

public:
static void initialize ()

Remarks

Note that this method will not work in a deployed application intended to use a Runtime license. See initialize for the constructor that takes a license key as a parameter. More information on how the Carmenta Engine license system works can be found here Carmenta Engine 5 Runtime Licenses.

This constructor activates the Thread Access Verifier.

initialize(bool verifyThreadAccess)

Initializes the Carmenta Engine runtime environment using the installed SDK license key and optional thread verification.

Syntax

C++

public:
static void initialize (
    bool verifyThreadAccess
)

Parameters

verifyThreadAccess

Type: bool
True to enable the thread access verifier; otherwise, False.

Remarks

initialize(const char* licenseKey)

Initializes the Carmenta Engine runtime environment with the given license key.

Syntax

C++

public:
static void initialize (
    const char* licenseKey
)

Parameters

licenseKey

Type: const char*
A Carmenta Engine license key. String containing the XML document with the license information.

Remarks

More information on how the Carmenta Engine license system works can be found here Carmenta Engine 5 Runtime Licenses.

This constructor activates the Thread Access Verifier.

initialize(const char* licenseKey, bool verifyThreadAccess)

Initializes the Carmenta Engine runtime environment with the given license key.

Syntax

C++

public:
static void initialize (
    const char* licenseKey,
    bool verifyThreadAccess
)

Parameters

licenseKey

Type: const char*
A Carmenta Engine license key. String containing the XML document with the license information.

verifyThreadAccess

Type: bool
True to enable the thread access verifier; otherwise, False.

Remarks

More information on how the Carmenta Engine license system works can be found here Carmenta Engine 5 Runtime Licenses.

Platforms

Windows, Linux, Android

Runtime.initialize Methods

Initializes the Carmenta Engine runtime environment.

Overload List

	Name	Description
Public method	initialize()	Initializes the Carmenta Engine runtime environment using the installed SDK license key.
Public method	initialize(boolean verifyThreadAccess)	Initializes the Carmenta Engine runtime environment using the installed SDK license key and optional thread verification.
Public method	initialize(String licenseKey)	Initializes the Carmenta Engine runtime environment with the given license key.
Public method	initialize(String licenseKey, boolean verifyThreadAccess)	Initializes the Carmenta Engine runtime environment with the given license key.

initialize()

Initializes the Carmenta Engine runtime environment using the installed SDK license key.

Syntax

Java

public static final void initialize ()

Remarks

This constructor activates the Thread Access Verifier.

initialize(boolean verifyThreadAccess)

Initializes the Carmenta Engine runtime environment using the installed SDK license key and optional thread verification.

Syntax

Java

public static final void initialize (
    boolean verifyThreadAccess
)

Parameters

verifyThreadAccess

Type: boolean
True to enable the thread access verifier; otherwise, False.

Remarks

initialize(String licenseKey)

Initializes the Carmenta Engine runtime environment with the given license key.

Syntax

Java

public static final void initialize (
    String licenseKey
)

Parameters

licenseKey

Type: String
A Carmenta Engine license key. String containing the XML document with the license information.

Remarks

More information on how the Carmenta Engine license system works can be found here Carmenta Engine 5 Runtime Licenses.

This constructor activates the Thread Access Verifier.

initialize(String licenseKey, boolean verifyThreadAccess)

Initializes the Carmenta Engine runtime environment with the given license key.

Syntax

Java

public static final void initialize (
    String licenseKey,
    boolean verifyThreadAccess
)

Parameters

licenseKey

Type: String
A Carmenta Engine license key. String containing the XML document with the license information.

verifyThreadAccess

Type: boolean
True to enable the thread access verifier; otherwise, False.

Remarks

More information on how the Carmenta Engine license system works can be found here Carmenta Engine 5 Runtime Licenses.

Platforms

Windows, Linux, Android

Runtime.initialize Methods

Initializes the Carmenta Engine runtime environment.

Overload List

	Name	Description
Public method	initialize()	Initializes the Carmenta Engine runtime environment using the installed SDK license key.
Public method	initialize(licenseKey)	Initializes the Carmenta Engine runtime environment with the given license key.

initialize()

Initializes the Carmenta Engine runtime environment using the installed SDK license key.

Syntax

Python

initialize (  )

Remarks

This constructor activates the Thread Access Verifier.

initialize(licenseKey)

Initializes the Carmenta Engine runtime environment with the given license key.

Syntax

Python

initialize ( licenseKey )

Parameters

licenseKey

Type: String
A Carmenta Engine license key. String containing the XML document with the license information.

Remarks

More information on how the Carmenta Engine license system works can be found here Carmenta Engine 5 Runtime Licenses.

This constructor activates the Thread Access Verifier.

Platforms

Windows, Linux, Android

Runtime.Initialize Methods

In this article

Overload List

Initialize()

Syntax

Remarks

Initialize(System.Boolean verifyThreadAccess)

Syntax

Parameters

Remarks

Initialize(System.String licenseKey)

Syntax

Parameters

Remarks

Initialize(System.String licenseKey, System.Boolean verifyThreadAccess)

Syntax

Parameters

Remarks

Platforms

See Also

Reference

Runtime::initialize Methods

In this article

Overload List

initialize()

Syntax

Remarks

initialize(bool verifyThreadAccess)

Syntax

Parameters

Remarks

initialize(const char* licenseKey)

Syntax

Parameters

Remarks

initialize(const char* licenseKey, bool verifyThreadAccess)

Syntax

Parameters

Remarks

Platforms

See Also

Reference

Runtime.initialize Methods

In this article

Overload List

initialize()

Syntax

Remarks

initialize(boolean verifyThreadAccess)

Syntax

Parameters

Remarks

initialize(String licenseKey)

Syntax

Parameters

Remarks

initialize(String licenseKey, boolean verifyThreadAccess)

Syntax

Parameters

Remarks

Platforms

See Also

Reference

Runtime.initialize Methods

In this article

Overload List

initialize()

Syntax

Remarks

initialize(licenseKey)

Syntax

Parameters

Remarks

Platforms

See Also

Reference