FlowEngine::LicenseManager Class Reference

Handles licensing. More...

#include <LicenseManager.h>

Static Public Member Functions
static FLE_DLL bool	isActivated ()
static FLE_DLL LicenseResult	activateOnline (ConstStringBuffer inKey, ConstStringBuffer inUserData=ConstStringBuffer())
static FLE_DLL LicenseResult	activateOffline (ConstStringBuffer inKey, ConstStringBuffer inFilePath)
static FLE_DLL LicenseResult	deactivateOnline ()
	Tries to deactivate the product online.
static FLE_DLL LicenseResult	createOfflineActivationRequest (ConstStringBuffer inKey, ConstStringBuffer inFilePath, ConstStringBuffer inUserData=ConstStringBuffer())
static FLE_DLL LicenseResult	createOfflineDeactivationRequest (ConstStringBuffer inFilePath)
static FLE_DLL Size	getFloatingLicenseServerSize ()
	Returns the stored TurboFloat server location address size (in dotted string notation).
static FLE_DLL LicenseResult	getFloatingLicenseServer (StringBuffer outHostAddress, unsigned short &outPort)
static FLE_DLL LicenseResult	saveFloatingLicenseServer (ConstStringBuffer inHostAddress, unsigned short inPort)
static FLE_DLL LicenseResult	clearFloatingLicenseServer ()
	Clear the information relative to the Floating License server.
static FLE_DLL Result	getLastDetailedErrorMessage (StringBuffer outString)
static FLE_DLL Size	getLastDetailedErrorMessageSize ()
static FLE_DLL Size	getProductKeyLength ()
static FLE_DLL Result	getProductKey (StringBuffer outKey)
static FLE_DLL Result	getLicenseInformation (LicenseInfoInterface &inOutInfo)

Detailed Description

Handles licensing.

Member Function Documentation

activateOffline()

LicenseResult FlowEngine::LicenseManager::activateOffline ( ConstStringBuffer  inKey, ConstStringBuffer  inFilePath  )

static

Tries to activate the product using an offline activation response

Parameters

inKey	the activation in key in the form xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx
inFilePath	the path to the file containing the activation response data

activateOnline()

LicenseResult FlowEngine::LicenseManager::activateOnline ( ConstStringBuffer  inKey, ConstStringBuffer  inUserData = ConstStringBuffer()  )

static

Tries to activate the product online

Parameters

inKey	the activation in key in the form xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx
inUserData	(optional) optional user data to associate with the activation.

clearFloatingLicenseServer()

LicenseResult FlowEngine::LicenseManager::clearFloatingLicenseServer ( )

static

Clear the information relative to the Floating License server.

createOfflineActivationRequest()

LicenseResult FlowEngine::LicenseManager::createOfflineActivationRequest ( ConstStringBuffer  inKey, ConstStringBuffer  inFilePath, ConstStringBuffer  inUserData = ConstStringBuffer()  )

static

Creates an offline activation license file for when an internet connection is not available or not desirable

Parameters

inKey	the activation in key in the form xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx
inFilePath	path to the file that will receive the offline activation request data
inUserData	(optional) optional user data to associate with the activation.

createOfflineDeactivationRequest()

LicenseResult FlowEngine::LicenseManager::createOfflineDeactivationRequest ( ConstStringBuffer  inFilePath )

static

Creates an offline deactivation request file for when an internet connection is not available or not desirable

Parameters

inFilePath

to the file that will receive the offline deactivation data

deactivateOnline()

LicenseResult FlowEngine::LicenseManager::deactivateOnline ( )

static

Tries to deactivate the product online.

getFloatingLicenseServer()

LicenseResult FlowEngine::LicenseManager::getFloatingLicenseServer ( StringBuffer  outHostAddress, unsigned short &  outPort  )

static

Returns the stored TurboFloat server location

Parameters

[out]	outHostAddress	a string buffer that will receive the stored TurboFloat server location. must be at least getFloatingLicenseServerSize() long.
[out]	outPort	a variable that will receive the host port.

Returns

One of the following result codes:

• LicenseResult::Success – if outHostAddress was filled with the stored TurboFloat server host address and outPort was filled with related port.
• LicenseResult::InvalidArgument – if outHostAddress is not a valid string buffer or is not big enough to receive the whole host address. See getFloatingLicenseServerSize().
• LicenseResult::Unsupported – if this method was called by the static licensing version of this SDK.

getFloatingLicenseServerSize()

Size FlowEngine::LicenseManager::getFloatingLicenseServerSize ( )

static

Returns the stored TurboFloat server location address size (in dotted string notation).

getLastDetailedErrorMessage()

Result FlowEngine::LicenseManager::getLastDetailedErrorMessage ( StringBuffer  outString )

static

Get last complete error message description for the last called LicenseManager function. If no error occurs, the string is empty.

Parameters

[in,out]

outString

buffer that contains the error message. The buffer must be at least getLastDetailedErrorMessageSize() long

getLastDetailedErrorMessageSize()

Size FlowEngine::LicenseManager::getLastDetailedErrorMessageSize ( )

static

Returns the camera image file path length

Returns

the number of characters required the last error message (excluding the termination character)

getLicenseInformation()

Result FlowEngine::LicenseManager::getLicenseInformation ( LicenseInfoInterface &  inOutInfo )

static

Returns information about the currently active license.

Parameters

[in,out]

inOutInfo

a LicenseInfo object that will receive the license information.

getProductKey()

Result FlowEngine::LicenseManager::getProductKey ( StringBuffer  outKey )

static

Retrieves the currently registered private key.

Parameters

[in,out]

outKey

A valid string buffer that will receive the key. It must be at least getPrivateKeyLength() long.

Precondition

A valid key must be successfully registered first.

Note

This method is valid only for static licensing.

Returns

One of the following result codes:

• Result::Success – if outKey was filled with the private key.
• Result::InvalidArgument – if outKey is not a valid string buffer.
• Result::BufferTooSmall – if outKey is not big enough to store a private key.
• Result::OutOfMemoryError – if the system ran out of memory when allocating temporary buffers.
• Result::FileNotFound – if there is not a valid key registered on the system.
• Result::GenericError – if any other error occurred. Check the log for more information.
• Result::FeatureNotAvailable – if this method is called by a floating license version.

getProductKeyLength()

Size FlowEngine::LicenseManager::getProductKeyLength ( )

static

Returns

the currently registered private key length, or 0 if no license is activated.

Note

This method is valid only for static licensing.

isActivated()

bool FlowEngine::LicenseManager::isActivated ( )

static

Returns

true if the license is activated, false otherwise

saveFloatingLicenseServer()

LicenseResult FlowEngine::LicenseManager::saveFloatingLicenseServer ( ConstStringBuffer  inHostAddress, unsigned short  inPort  )

static

Set the location of the Floating License server. When set, the floating license server will be the preferred method to validate the license.

Parameters

inHostAddress	the server address in dotted notation
inPort	the server port