SoLockManager Class Reference

Sets the unlock string. More...

#include <Inventor/lock/SoLockMgr.h>

Static Public Member Functions
static void	SetUnlockString (char *pUnlockString)
	Sets the unlock string.
static void	AppendUnlockString (const char *unlockString)
	Appends to the existing unlock string the specified string.
Deprecated
static SoDEPRECATED char *	GetUnlockString ()
	Returns the unlock string.

Detailed Description

Sets the unlock string.

This class allows the application to set Master Password unlock strings programmatically.

Only Master Password unlock strings can be used with this class.
Temporary and floating license strings have a different format. These license strings can be set, but will not unlock Open Inventor. They must be used with a license string file.

Master Password strings embedded in application code must be "obfuscated" to prevent them being easily extracted from the executable. The application should remove the obfuscation immediately before calling SetUnlockString().

You must also ensure that the master password is not readable in the files you redistribute.

If your application uses any of the Open Inventor extensions (e.g., MeshViz, VolumeViz, etc.), you must specify the necessary license strings using a colon-separated list or a newline-separated list. Effectively SoLockManager stores only a single string, so each call to the method SetUnlockString after the first one overwrites the previously specified value. You must use the AppendUnlockString method to add additional license strings after the initial call to SetUnlockString.

You must set the unlock string before your call to SoXt::init, SoWin::init (Windows platforms only) or SoDB::init. This means the password string should typically be specified in your application's main or WinMain .

Definition at line 66 of file SoLockMgr.h.

Member Function Documentation

AppendUnlockString()

static void SoLockManager::AppendUnlockString ( const char *  unlockString )

static

Appends to the existing unlock string the specified string.

In order for the unlock string to be valid, each feature described must be specified in a single line.

GetUnlockString()

static SoDEPRECATED char * SoLockManager::GetUnlockString ( )

static

Returns the unlock string.

For security reason, this method always returns NULL.

Returns

NULL

SetUnlockString()

static void SoLockManager::SetUnlockString ( char *  pUnlockString )

static

Sets the unlock string.

SoLockManager makes a copy of the specified string, so it is not necessary to declare a static string.
To reclaim the memory allocated by SoLockManager (for example at program exit), simply call setUnlockString with NULL.

---

The documentation for this class was generated from the following file:

• Inventor/lock/SoLockMgr.h