GetDataSetEx2

Description

Gets a data set in XML format that meets the criteria specified in the filter.

Note that to call this function, you must:

  • Set the AdminEncryptionKey
void GetDataSetEx (string webServiceUrl, string table, 
                   string filter, int maxRecords, 
                   string distinctFieldValue, string uniqueIDField, 
                   ref string dataSet, out string response)

Parameters

ParameterTypeDescription
webServiceUrlstringURL to the QLM License Server.
tablestringspecify the table to query. The possible values are:

qryLicenseInfo: the main table where all license keys are recorded.
qryActivationLog: the table containing the activation log for multiple activations keys.
qryLicenseHistoryInfo: the table containing historical keys.
qryAnalyticsInstalls: the table containing Analytics.
qryActivationAttempts: the table containing the activation attempts.
qryIllegalComputers: the table containing the illegal computers.
filterstringSQL filter to determine which records to return. Use a where clause sql syntax, example: ActivationKey='AAAA'. Note that if the filter contains an Activation Key or a Computer Key, you must strip out the dashes in the license key. License keys in the database are stored without dashes.
maxRecordsintthe maximum number of records to return. Set the value to -1 to return all records.
distinctFieldValuestringname of a field whose value should be distinct in the returned records
uniqueIDFieldstringname of a field that will be used to identify which record to return when multiple records have the same value in the specified distinctField.
dataSetstringreturned dataset containing license key records that match criteria
responsestringXML fragment containing the result of the call.

Response XML format

<?xml version='1.0' encoding='UTF-8'?>
<QuickLicenseManager>
<result>Successfully executed query using filter...</result>
</QuickLicenseManager>

Example error response

<?xml version='1.0' encoding='UTF-8'?>
<QuickLicenseManager>
<error>Details about the error</error>
</QuickLicenseManager>

Remarks

Use ParseResults to interpret the results of the call and load the returned data into an ILicenseInfo object.

ILicenseInfo li = new LicenseInfo();
string message = string.Empty;
if (lv.QlmLicenseObject.ParseResults(response, ref li, ref message))
{
  // The operation  was successful  
}
else
{
  // The operation failed
}

Requirements

  • QLM Enterprise