SK_SOLO_ActivateInstallationGetRequest Function

Builds a request to send to the XmlActivationService web service's ActivateInstallationLicenseFile method in SOLO Server.

Remarks

Important Note

The XML document returned in the request parameter must be freed from memory! The SK_XmlDocumentDispose function is recommended for this purpose.

The string returned in the sessionCode parameter must be freed from memory! The SK_StringDispose function is recommended for this purpose.

Syntax

C/C++
SK_ResultCode SK_SOLO_ActivateInstallationGetRequest(SK_ApiContext context, int flags, int licenseId, const char *pw, const char *serialNum, int userCode1, int userCode2, SK_BOOL requireRegistration, const char *installationName, const char *prevInstallationId, SK_XmlDoc *request, char **sessionCode);
Visual Basic
Declare Function SK_SOLO_ActivateInstallationGetRequest(ByVal context As Long, ByVal flags As Long, ByVal licenseId As Long, ByVal pw As String, ByVal serialNum As String, ByVal userCode1 As Long, ByVal userCode2 As Long, ByVal requireRegistration As Long, ByVal installationName As String, ByVal prevInstallationId As String, ByRef request As Long, ByRef sessionCode As String) As Long

Arguments

context
The API Context handle.
flags
Any flags passed into this function-call.
licenseId
The License ID issued by SOLO Server.
pw
The activation password for the license, or customer password, in SOLO Server.
serialNum
The Serial Number issued for the license in SOLO Server (leave this field empty when using the License ID and password).
userCode1
This is only used for issuing Protection PLUS 4 compatible Trigger Codes, and is the User-Code 1 value (or session code). Use a value of 1000 if you are not using Protection PLUS 4 compatibility features.
userCode2
This is only used for issuing Protection PLUS 4 compatible Trigger Codes, and is the User-Code 2 value (or Computer ID). Use a value of 1000 if you are not using Protection PLUS 4 compatibility features.
requireRegistration
Set to TRUE (1) when the customer must have their contact information (such as name, email, etc...) registered with SOLO Server before activation is permitted.
installationName
The optional, human-readable name of this installation. This may be a entered by your users, or may be a value of your choosing.
prevInstallationId
The optional, previous Installation ID which was last used on the system being activated.
request
Reference/pointer to a SK_XmlDoc handle, which will point to the XML document handle that contains the request when the call succeeds. The handle must be initialized to NULL (0) prior to calling this function.
sessionCode
Reference/pointer to a string pointer, which will point to the string which contains the unique session code generated for this request when the call succeeds. The string pointer must be initialized to NULL (0) prior to calling this function.

Returns

All possible return values are included in the SK_ResultCode enumeration. Return codes to expect include:

Result Code Description
SK_ResultCode.SK_ERROR_NONE No error.
SK_ResultCode.SK_ERROR_INVALID_ARGUMENTS Some or all of the arguments are invalid.