LSGetMessage(3nw)


LSGetMessage -- gets string describing current error code

Synopsis

   LS_STATUS_CODE LSGetMessage( 
      LS_HANDLE          licenseHandle, 
      LS_STATUS_CODE     value, 
      LS_HANDLE         *buffer, 
      LS_ULONG           bufferSize); 

Description

The parameters are as follows:

licenseHandle
(IN) Specifies the handle that identifies the license context. This argument must be a handle that was created with a successful or unsuccessful call to LSRequest.

value
(IN) Specifies any status code that can be returned by an LSAPI function (see ``NLS status codes'').

buffer
(OUT) Points to a buffer where the localized error message string is returned.

bufferSize
(IN) Specifies the maximum size of information that licensing system returns to buffer.

Return values

The resulting detailed status of the LSGetMessage function:

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_BAD_ARG
One or more parameters are invalid.

LS_BAD HANDLE
licenseHandle did not describe a valid license system context.

Notices

For a given error code, LSGetMessage returns a string describing the error. The string describes the error and a recommended action to take. If value is LS_USE_LAST, the last error associated with the supplied licensing handle is returned; otherwise, the supplied error code is used.
30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.