LSQuery(3nw)
LSQuery --
gets information about a license certificate
Synopsis
LS_STATUS_CODE LSQuery(
LS_HANDLE licenseHandle,
LS_ULONG information,
LS_VOID
infoBuffer,
LS_ULONG bufferSize,
LS_ULONG
actualBufferSize);
Description
The parameters are as follows:
- licenseHandle
-
(IN) Specifies a handle identifying the license context. This must be a handle created by a successful call to LSRequest.
- information
-
(IN) Identifies the information to be returned:
- LS_INFO_NONE
-
Reserved
- LS_INFO_SYSTEM
-
Returns the unique ID of the licensing system supplying the current license
context. This ID is a NULL-terminated string equivalent to the value returned
by the LSEnumProviders function
- LS_INFO_DATA
-
Returns the entire license certificate. The first LS_ULONG in the
data buffer indicates the size in bytes of the data that follows.
- LS_UPDATE_PERIOD
-
Returns the recommended interval in minutes at which LSUpdate
should be called. This value is returned as an LS_ULONG in the
data buffer. If a value of 0xFFFFFFFF is returned, no recommended update
period exists for the associated system.
- infoBuffer
-
(OUT) Points to a buffer where the resulting information is returned.
- bufferSize
-
(IN) Specifies the maximum number of bytes for the licensing system to return in infoBuffer. This should be large enough to hold the expected data; otherwise, the
status code LS_BUFFER_TOO_SMALL is returned, and only bufferSize bytes of data are returned.
- actualBufferSize
-
(OUT) Points to the number of bytes of information actually put in infoBuffer. This value does not include any trailing NULL bytes.
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
LSQuery gets information about license units obtained by calling LSRequest. For example, an application can determine the license type, time restrictions, and
so on.
30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.