IDomain

Description

interface Tinman.Licence.IDomain

The IDomain interface provides low-level functions for checking licence keys and unlocking protected data.

Public / Methods

Key

public method Key → (1)

key ⁱⁿ : int8 [ ]: The binary licence key.
returns → int32: > 0 : the domain has been unlocked.
= 0 : the licence key is valid but cannot unlock this domain.
< 0 : the licence key is invalid.

Tries to unlock this domain using the given binary licence key.

The given key ⁱⁿ array will only be referenced during the call to this method, so it is safe to use this method even if the low-level licence module uses a different native heap.

Locked

[Pure]
public method Locked → (1)

locked ⁱⁿ : int32: The data item ID.
returns → string: The locked data item or null.

Returns a locked data item.

The returned string value will always be a literal. On platforms other than .NET, the native string object will wrap the literal directly, so the value returned by this method can safely be used, even if the low-level licence module uses a different native heap.

Unlock

public method Unlock → (2)

input ⁱⁿ : int8 [ ]: Input buffer holding the locked data item bytes.
output ⁱⁿ : int8 [ ]: Output buffer for unlocked data item bytes.
returns → int32: = 0 : The number of bytes that have been written to output ⁱⁿ.
< 0 : The required output buffer length (negated), if null or too small.

Unlocks the given data item.

The given input ⁱⁿ and output ⁱⁿ arrays will only be referenced during the call to this method, so it is safe to use this method even if the low-level licence module uses a different native heap.

UseMagic

public method UseMagic → (1)

magic ⁱⁿ : MagicDelegate: The magic delegate.

Performs some magic.

Public / Attributes

HasMagic

public attribute HasMagic → (get)

value : bool: true if the domain has some magic,
false if it does not have any magic.

Checks if this domain has some magic.