Initialization Functions

Functions
DPS_API void *	DPS_CreateInstance ()
DPS_API void	DPS_DestroyInstance (void *hStitcher)
DPS_API int	DPS_InitLicense (void *hStitcher, const char *pLicense)
DPS_API int	DPS_InitLicenseFromServer (void *hStitcher, const char *pLicenseServer, const char *pLicenseKey)
DPS_API int	DPS_InitLicenseFromLicenseContent (void *hStitcher, const char *pLicenseKey, const char *pLicenseContent)
DPS_API int	DPS_OutputLicenseToStringPtr (void *hStitcher, char **content)
DPS_API void	DPS_FreeLicenseString (char **content)

Function Documentation

DPS_CreateInstance()

DPS_API void* DPS_CreateInstance

(

)

Creates an instance of Dynamsoft Panorama.

Returns

Returns an instance of Dynamsoft Panorama. If failed, it returns NULL.

Code Snippet:

void* panorama = DPS_CreateInstance();
DPS_DestroyInstance(panorama);

DPS_DestroyInstance()

DPS_API void DPS_DestroyInstance

(

void *

hStitcher

)

Destroys an instance of Dynamsoft Panorama.

Parameters

[in]

hStitcher

Handle of the Panorama instance.

Code Snippet:

void* panorama = DPS_CreateInstance();
DPS_DestroyInstance(panorama);

DPS_FreeLicenseString()

DPS_API void DPS_FreeLicenseString

(

char **

content

)

Frees memory allocated for the license string.

Parameters

[in]

content

The output string which stores the content of license.

Remarks:

If you used DPS_OutputLicenseToStringPtr() method, you will need to call this DPS_FreeLicenseString() method to release memory.

DPS_InitLicense()

DPS_API int DPS_InitLicense	(	void *	hStitcher,
		const char *	pLicense
	)

Reads the product key and activates the SDK.

Parameters

[in]	hStitcher	Handle of the Panorama instance.
[in]	pLicense	The product key.

Returns

Returns error code. Returns 0 if the function operates successfully. You can call DPS_GetErrorString() to get detailed error message.

Code Snippet:

void* panorama = DPS_CreateInstance();
DPS_InitLicense(panorama, "t0260NwAAAHV***************");
DPS_DestroyInstance(panorama);

DPS_InitLicenseFromLicenseContent()

DPS_API int DPS_InitLicenseFromLicenseContent	(	void *	hStitcher,
		const char *	pLicenseKey,
		const char *	pLicenseContent
	)

Initializes Panorama license from the license content on the client machine for offline verification.

Parameters

[in]	hStitcher	Handle of the Panorama instance.
[in]	pLicenseKey	The license key.
[in]	pLicenseContent	An encrypted string which represents the license content (quota, expiration date, barcode type, etc.) obtained from the method DPS_OutputLicenseToString().

Returns

Returns error code. Returns 0 if the function operates successfully. You can call DPS_GetErrorString() to get detailed error message.

DPS_InitLicenseFromServer()

DPS_API int DPS_InitLicenseFromServer	(	void *	hStitcher,
		const char *	pLicenseServer,
		const char *	pLicenseKey
	)

Initializes Panorama license and connects to the specified server for online verification.

Parameters

[in]	hStitcher	Handle of the Panorama instance.
[in]	pLicenseServer	The name/IP of the license server.
[in]	pLicenseKey	The license key.

Returns

Returns error code. Returns 0 if the function operates successfully. You can call DPS_GetErrorString() to get detailed error message.

DPS_OutputLicenseToStringPtr()

DPS_API int DPS_OutputLicenseToStringPtr	(	void *	hStitcher,
		char **	content
	)

Outputs the license content as an encrypted string from the license server to be used for offline license verification.

Parameters

[in]	hStitcher	Handle of the Panorama instance.
[in,out]	content	The output string which stores the content of the license.

Returns

Returns error code. Returns 0 if the function operates successfully. You can call DPS_GetErrorString() to get detailed error message.

Remarks:

You need to call DPS_InitLicenseFromServer() prior to DPS_OutputLicenseToStringPtr() method.