WR_LFGetString

Use this function to obtain the string values of the variables stored in the license file. You may use any of the User Defined fields to store your own data freely.

Important

The buffer must first be initialized to a length of at least five characters longer than the length of the field being retrieved. Please refer to the available fields table for the field lengths.

Additionally, in Visual Basic, if the buffer is dimensioned at 55 characters and the data received is only 40 characters, there may be null or other characters after the valid data. We have found the easiest way to trim off these extra characters is to place the data into a hidden text box on a form and retrieve it back. The new value will be just the desired data.

Syntax

Visual Basic
Declare Function WR_LFGetString(ByVal flags As Long, ByVal var_no As Long, ByVal buffer As String) As Long
C/C++:
LONG WR_LFGetString(LONG flags, LONG var_no, LPSTR buffer)

Arguments

flags
Reserved. Set to 0
var_no
Determines which variable in the license file is being retrieved. See the available fields table below.
buffer
The variable in which the license field data will be stored.

Returns

If the call fails, any of the API Error Codes may be returned.

-2
The application has not been wrapped.
-1
The API is not available. Please check your wizard settings. See the Testing section in the API Setup topic for more information.
1
The the license file field's value was successfully stored in buffer.

Available Fields

Field ID Size in Characters Description
1 50 Registration Company Name
2 50 Registration Customer Name
3 50 Registration Address 1
4 50 Registration Address 2
5 50 Registration Address 3
6 20 Registration Phone
7 20 Registration Fax
8 n/a Reserved
9 1 Expiration Type
10 50 User Defined 1
11 50 User Defined 2
12 50 User Defined 3
13 50 User Defined 4
14 50 User Defined 5
15 50 User Defined 6
16 50 User Defined 7*
17 50 User Defined 8*
18 50 User Defined 9*
19 50 User Defined 10
20 through 28 n/a Reserved
29 79 Registration Country
30 79 Registration Email
31 through 32 n/a Reserved
33 20 Activation Password
34 34 Installation ID
1000 n/a Product Name**

* These fields are reserved if you are allowing activations from another computer (or offline activations).

** These fields retrieve injected parameters that are read-only and not stored in the license file. The length of these fields depends on the data that was injected.