NLSInstalled(3nw)
NLSInstalled --
provides information about license units that are installed for products in one or all licensing systems
Synopsis
LS_STATUS_CODE NLSInstalled(
LS_STR
licenseSystem,
LS_STR
serverName,
LS_STR
publisher,
LS_STR
product,
LS_STR
version,
LS_ULONG maxStrLen,
LS_STR
installedPublisher,
LS_STR
installedProduct,
LS_STR
installedVersion,
LS_LICENSE_ID installedLicenseID,
LS_ULONG
numInstalledUnits,
LS_ULONG
index);
Description
The parameters are as follows:
- licenseSystem
-
(IN) Points to the licensing systems to search for the specified products. It can either be the specific name of a licensing system, as returned by LSEnumProviders, or
it can be LS_ANY. If LS_ANY is specified, information is returned from all licensing systems accessible from this client.
- serverName
-
(IN) Points to the server that contains the license certificate database needed to search for the specified products. It should be the DN of the server, or LS_ANY. If
LS_ANY is specified, information from all LSPs registered in the NDS directory tree (from the current context to the root) is returned.
- publisher
-
(IN) Points to the publisher name to filter by. Only transactions that have this publisher name are returned. LS_ANY indicates that any publisher name can appear in the
returned entry.
- product
-
(IN) Points to the product name to filter by. Only transactions that have this product name are returned. LS_ANY indicates that any product name can appear in the
returned entry.
- version
-
(IN) Points to the version string to filter by. Only transactions that have this version string are returned. LS_ANY indicates that any version string can appear in the
returned entry.
- maxStrLen
-
(IN) Specifies the maximum length (in bytes) of string output that can be placed into availablePublisher, availableProduct, and availableVersion. If
any of these output strings is longer than maxStrLen, LS_BUFFER_TOO_SMALL is returned.
- installedPublisher
-
(OUT) Points to the name of an installed publisher, based on current value of index.
- installedProduct
-
(OUT) Points to the name of an installed product, based on current value of index.
- installedVersion
-
(OUT) Points to the current installed version, based on the current value of index.
- installedLicID
-
(OUT) Returns the unique identifier/serial number (within specified publisher, product, version domain) of the license certificate from which this information was retrieved.
- numInstalledUnits
-
(OUT) Points to the number of available license units at the time the function was called. This does not necessarily indicate the number of installed instances of a product,
because availableUnits might represent something else based on the application's licensing policy. Also, this takes into account the current connection status of the
user calling NLSAvailable. If the certificate is not available, availableUnits is zero. When used in combination with NLSInUse and
NLSInstalled, this condition can be easily detected.
- index
-
(IN/OUT) Used to iterate through the entire list of publisher/product/version combinations that are currently available. index should be initialized to zero on the
first call to the function, then opaquely passed back into the function on successive calls. To retrieve all information, continue this process until LS_BAD_INDEX is
returned.
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_BAD INDEX
-
Index does not point to a valid license certificate. This usually occurs when the end of the requested information has been completely returned.
- LS_BAD_ARG
-
One or more parameters are invalid.
- LS_BUFFER_TOO_SMALL
-
maxStrLen did not indicate a buffer large enough to hold one of the requested output parameters.
Notices
NLSInstalled determines what products are available from a client. Filtering can be performed to get information for a specific product. If the filtering is changed,
the index parameter should be reset to zero to get all information relating to the newly specified parameters. When LS_BAD_INDEX is returned by NLSInstalled,
all information relating to the specified filtering parameters has been returned.
30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.