VLScleanExpiredCommuterCode

Syntax

int VLScleanExpiredCommuterCode (	 	 
unsigned char	 	*feature_name,
unsigned char	 	*feature_version,
unsigned char	 	*log_comment
unsigned long	 	*unused );

Argument

Description

feature_name

Name of the feature.

feature_version

Version of the feature.

log_comment

 

>If vendor usage data attribute consists of multiple words, each will be anonymized individually, only if they are separated using a space. In general, avoid specifying the same entry (or word) twice in the vendor usage data attribute as the "uniquely" anonymized data will be repeated.

>The spaces in the vendor usage data attribute are replaced with underscores (_). Also, the keyword <an> itself is not anonymized and is replaced by an underscore (_) in the resulting usage log line record.

>To complete the vendor usage data attribute anonymization process, the system administrator must have also allowed anonymity of user information (either by setting the LS_LOG_ANONYMITY environment variable or using the -log-anonymity License Manager start-up option).

The API truncates the log comment in the following case:

>The log comment value, when the <an> tag is not used, has exceeded the maximum allowed buffer size. Up to 100 characters are allowed (excluding the null character).

In the following cases, VLS_CALLING_ERROR is returned:

>The log comment probably consists of the hash (#) sign in the beginning or end of the string. Also, it should not contain consecutive hash signs.

>The log comment value, when the <an> tag is used, has exceeded the maximum allowed buffer size obtained using the following guidelines. If you plan to have only a part of data as anonymized, then use the following formula to calculate the maximum allowed data: 100 bytes = 17x + y, where "x" is the number of words to be anonymized and "y" is the length of the unanonymized data. If you plan to have only anonymized characters in the usage log file, then after the anonymization tag <an>, up to 6 words separated by a space can be included.

unused

Reserved for future use. Use NULL as the value for this argument.

Description 

Cleans the expired commuter authorization on a client system (both remote and normal).

Returns

The status code LS_SUCCESS is returned if successful. For a complete list of the error codes, see Licensing Library Error and Result Codes.