LSRelease(3nw)

Synopsis

   LS_STATUS_CODE LSRelease( 
      LS_HANDLE    licenseHandle, 
      LS_ULONG     totUnitsConsumed, 
      LS_STR      logComment); 

Description

licenseHandle

(IN) Specifies a handle identifying the license context. licenseHandle must be a handle received from a successful call to LSRequest.

totUnitsConsumed

(IN) Specifies the total number of units consumed in this license handle context since LSRequest was initially called. The software publisher can specify this policy attribute within the application. A value of LS_DEFAULT_UNITS indicates that the licensing system should determine the appropriate value using its own licensing policy mechanisms.

logComment

(IN) Points to an optional string indicating a comment to be associated with the release and logged by NLS. The comment is logged even if an error is returned. To avoid logging the comment, specify LS_NULL.

Return values

This function returns a detailed error code that can be directly processed by the caller, or that can be converted by LSGetMessage to one of these message strings:

LS_SUCCESS

The requested functionality completed successfully.

LS_SYSTEM_UNAVAILABLE

DOS TSR or Windows DLL is not properly configured or available, or client has no licensing system to communicate with.

LS_RESOURCES_UNAVAILABLE

Insufficient resources (such as memory) available to complete request.

LS_AUTHORIZATION_UNAVAILABLE

Current user was not security-equivalent to the original creator of the licensing handle.

LS_BAD_ARG

One or more parameters are invalid.

LS_BAD HANDLE

licenseHandle did not indicate a currently valid licensing handle.

Notices

LSRelease releases licensing units associated with the license context identified by licenseHandle. The license handle context is not freed; to free the handle, call LSFreeHandle.

To successfully release license units, the user associated with the current connection must be security-equivalent to the original creator of the license handle (from LSRequest).