ACTIVESWLib::ISPLicenseClient Interface Reference

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPLicenseClientInterface ISPLicenseClient.

ISPLicenseClient connects with a license service to load and install a license locally.

Connection parameters are typically loaded from the registry and may be overruled by the api functions, see SetPropertyInt, SetPropertyString.

Please read section sec_LicenseClient for more information about installing licenses from a SOFTPRO license service

Public Member Functions

HRESULT Clone ([out] ISPLicenseClient **ppClone,[out, retval] long *result)

Copy a PropertyMap object.

HRESULT Create ([out, retval] long *result)

Create a SPLicenseClient object.

HRESULT GetDetailError ([in] BSTR bstrLanguage,[in] long lDetail,[out] BSTR *pbstrDetail,[out, retval] long *result)

Query a readable error description for a detailed error code.

HRESULT GetPropertyInt ([in] BSTR bstrName,[out] long *plValue,[out, retval] long *result)

Query the content of a property.

HRESULT GetPropertyString ([in] BSTR bstrName,[out] BSTR *pbstrValue,[out, retval] long *result)

Query the string content of a property.

HRESULT GuiRequest ([in] __int64 hwndParent,[in] BSTR bstrLanguage,[out] long *plDetail,[out, retval] long *result)

Get a license file from the SOFTPRO license service with GUI.

HRESULT GuiRequest32 ([in] __int32 hwndParent,[in] BSTR bstrLanguage,[out] long *plDetail,[out, retval] long *result)

Get a license file from the SOFTPRO license service with GUI.

HRESULT Request ([in] BSTR bstrRegistrationCode,[out] long *plDetail,[out, retval] long *result)

Get a license file from the SOFTPRO license service without GUI.

HRESULT SetPropertyInt ([in] BSTR bstrName,[in] long lValue,[out, retval] long *result)

Set the value of a property.

HRESULT SetPropertyString ([in] BSTR bstrName,[in] BSTR bstrValue,[out, retval] long *result)

Set the string content of a property.

Member Function Documentation

HRESULT ACTIVESWLib::ISPLicenseClient::Clone ( [out] ISPLicenseClient ** ppClone,

[out, retval] long * result

)

Copy a PropertyMap object.

Parameters:

ppClone [o] a pointer to a ISPLicenseClient object that will be filled with the newly created property map object.

result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:

SPX_MEMERR out of memory

Returns:
automation result

Note:
The newly created object will be a true copy of the copy object

See also:
SPLicenseClientClone

HRESULT ACTIVESWLib::ISPLicenseClient::Create ( [out, retval] long * result )

Create a SPLicenseClient object.

Parameters:

result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:

SPX_MEMERR out of memory

Returns:
automation result

See also:
SPLicenseClientCreate

HRESULT ACTIVESWLib::ISPLicenseClient::GetDetailError ( [in] BSTR bstrLanguage,

[in] long lDetail,

[out] BSTR * pbstrDetail,

[out, retval] long * result

)

Query a readable error description for a detailed error code.

Parameters:

bstrLanguage [i] two character language, "de" for German, "en" for English

lDetail [i] detailed error code as returned from Request and GuiRequest

pbstrDetail [o] Pointer to a string wich will be filled with the detailed error description

result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:

SPX_PARAMERR an invalid parameter was passed
SPX_MEMERR out of memory

Returns:
automation result

See also:
Request, SPLicenseGuiRequest, GetDetailError

HRESULT ACTIVESWLib::ISPLicenseClient::GetPropertyInt ( [in] BSTR bstrName,

[out] long * plValue,

[out, retval] long * result

)

Query the content of a property.
Please read sec_SPLC_Properties for details on the evaluated properties

Parameters:

bstrName [i] the name of the property

plValue [o] pointer to an integer that will be filled with the contents of the property.

result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:

SPX_PARAMERR undefined property, or not an integer

Returns:
automation result

See also:
SetPropertyInt, SPLicenseGetPropertyInt

HRESULT ACTIVESWLib::ISPLicenseClient::GetPropertyString ( [in] BSTR bstrName,

[out] BSTR * pbstrValue,

[out, retval] long * result

)

Query the string content of a property.
Please read sec_SPLC_Properties for details on the evaluated properties

Parameters:

bstrName [i] the name of the property

pbstrValue [o] pointer to a char pointer that will be filled with the contents of the property. Memory will be allocated as required.

result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:

SPX_PARAMERR undefined property

Returns:
automation result

See also:
SetPropertyString, SPLicenseGetPropertyString

HRESULT ACTIVESWLib::ISPLicenseClient::GuiRequest ( [in] __int64 hwndParent,

[in] BSTR bstrLanguage,

[out] long * plDetail,

[out, retval] long * result

)

Get a license file from the SOFTPRO license service with GUI.

Note:
URL of the license service and proxy settings are read from the registry and may be overruled by SetPropertyInt and SetPropertyString
The SDK result will be SPX_NOERR on success or an error code. A detailed error description will be returned via GetDetailError

Parameters:

hwndParent [i] Window handle of the parent frame or diaolg to create a modal dialog

bstrLanguage [i] two character language, "de" for German, "en" for English

plDetail [o] pointer to a long that will be filled with a detailed error code, if applicable

result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:

SPX_CANCELERR the operation was cancelled by the user
SPX_PARAMERR an invalid parameter was passed
SPX_OPENERR the service could not be accessed, check piResult for details
SPX_LICENSEERR the license could not be loaded, check piResult for details
SPX_LINKLIBRARYERR ssome modules could not be loaded or are missing

Returns:
automation result

See also:
Request, SPLicenseGuiRequest, GetDetailError

HRESULT ACTIVESWLib::ISPLicenseClient::GuiRequest32 ( [in] __int32 hwndParent,

[in] BSTR bstrLanguage,

[out] long * plDetail,

[out, retval] long * result

)

Get a license file from the SOFTPRO license service with GUI.

Note:
This method is exclusively for 32-bit applications, it will return an error (SPX_PARAMERR) in a 64-bit process
URL of the license service and proxy settings are read from the registry and may be overruled by SetPropertyInt and SetPropertyString
The SDK result will be SPX_NOERR on success or an error code. A detailed error description will be returned via GetDetailError

Parameters:

hwndParent [i] Window handle of the parent frame or diaolg to create a modal dialog

bstrLanguage [i] two character language, "de" for German, "en" for English

plDetail [o] pointer to a long that will be filled with a detailed error code, if applicable

result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:

SPX_CANCELERR the operation was cancelled by the user
SPX_PARAMERR an invalid parameter was passed
SPX_OPENERR the service could not be accessed, check piResult for details
SPX_LICENSEERR the license could not be loaded, check piResult for details
SPX_LINKLIBRARYERR ssome modules could not be loaded or are missing

Returns:
automation result

See also:
Request, SPLicenseGuiRequest, GetDetailError

HRESULT ACTIVESWLib::ISPLicenseClient::Request ( [in] BSTR bstrRegistrationCode,

[out] long * plDetail,

[out, retval] long * result

)

Get a license file from the SOFTPRO license service without GUI.

Note:
URL of the license service and proxy settings are read from the registry and may be overruled by SetPropertyInt and SetPropertyString
The SDK result will be SPX_NOERR on success or an error code. A detailed error description will be returned via GetDetailError

Parameters:

bstrRegistrationCode [i] the registration code

plDetail [o] pointer to a long that will be filled with a detailed error code, if applicable

result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:

SPX_CANCELERR the operation was cancelled by the user
SPX_PARAMERR an invalid parameter was passed
SPX_OPENERR the service could not be accessed, check piResult for details
SPX_LICENSEERR the license could not be loaded, check piResult for details
SPX_LINKLIBRARYERR ssome modules could not be loaded or are missing

Returns:
automation result

See also:
GuiRequest, SPLicenseClientRequest, GetDetailError

HRESULT ACTIVESWLib::ISPLicenseClient::SetPropertyInt ( [in] BSTR bstrName,

[in] long lValue,

[out, retval] long * result

)

Set the value of a property.
Please read sec_SPLC_Properties for details on the evaluated properties

Parameters:

bstrName [i] the name of the property

lValue [i] the value of the property

result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:

SPX_MEMERR out of memory

Returns:
automation result

See also:
GetPropertyInt, SPLicenseSetPropertyInt

HRESULT ACTIVESWLib::ISPLicenseClient::SetPropertyString ( [in] BSTR bstrName,

[in] BSTR bstrValue,

[out, retval] long * result

)

Set the string content of a property.
Please read sec_SPLC_Properties for details on the evaluated properties

Parameters:

bstrName [i] the name of the property

bstrValue [i] pointer to the string that should be passed to the property

result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:

SPX_MEMERR out of memory

Returns:
automation result

See also:
GetPropertyString, SPLicenseSetPropertyString

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

ActiveSW.idl


Public Member Functions
HRESULT	Clone ([out] ISPLicenseClient *ppClone,[out, retval] long result)
	Copy a PropertyMap object.
HRESULT	Create ([out, retval] long *result)
	Create a SPLicenseClient object.
HRESULT	GetDetailError ([in] BSTR bstrLanguage,[in] long lDetail,[out] BSTR pbstrDetail,[out, retval] long result)
	Query a readable error description for a detailed error code.
HRESULT	GetPropertyInt ([in] BSTR bstrName,[out] long plValue,[out, retval] long result)
	Query the content of a property.
HRESULT	GetPropertyString ([in] BSTR bstrName,[out] BSTR pbstrValue,[out, retval] long result)
	Query the string content of a property.
HRESULT	GuiRequest ([in] __int64 hwndParent,[in] BSTR bstrLanguage,[out] long plDetail,[out, retval] long result)
	Get a license file from the SOFTPRO license service with GUI.
HRESULT	GuiRequest32 ([in] __int32 hwndParent,[in] BSTR bstrLanguage,[out] long plDetail,[out, retval] long result)
	Get a license file from the SOFTPRO license service with GUI.
HRESULT	Request ([in] BSTR bstrRegistrationCode,[out] long plDetail,[out, retval] long result)
	Get a license file from the SOFTPRO license service without GUI.
HRESULT	SetPropertyInt ([in] BSTR bstrName,[in] long lValue,[out, retval] long *result)
	Set the value of a property.
HRESULT	SetPropertyString ([in] BSTR bstrName,[in] BSTR bstrValue,[out, retval] long *result)
	Set the string content of a property.