NLSGetCertificate(3nw)


NLSGetCertificate -- retrieves the data that makes up a license certificate

Synopsis

   LS_STATUS_CODE NLSGetCertificate( 
      LS_STR          *licenseSystem, 
      LS_STR          *publisherName, 
      LS_STR          *productName, 
      LS_STR          *version, 
      LS_LICENSE_ID    licenseID, 
      LS_ULONG         maxBufferLen, 
      LS_VOID         *licenseCertificate, 
      LS_ULONG        *actualBufferLen); 

Description

The parameters are as follows:

licenseSystem
(IN) Points to the licensing system in which the license certificate to retrieve is located. Specify a specific licensing system name as received from LSEnumProviders, or specify LS_ANY to initiate a search for the first matching certificate.

publisherName
(IN) Points to the publisher name of license certificate to get (cannot be NULL or LS_ANY).

productName
(IN) Points to the product name of license certificate to get (cannot be NULL or LS_ANY).

version
(IN) Points to the version string of license certificate to get (cannot be NULL or LS_ANY).

licenseID
(IN) Specifies the license certificate ID or serial number of license certificate to get.

maxBufferLen
(IN) Specifies the maximum amount of data (in bytes) that can be placed into the buffer pointed to by licenseCertificate.

licenseCertificate
(OUT) Points to a buffer in which the license certificate is to be placed. This buffer is filled only if the return is LS_SUCCESS.

actualBufferLen
(OUT) Points to the actual number of bytes the license certificate inhabits in the buffer pointed to by licenseCertificate.

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

LS_BUFFER_TOO_SMALL
The maxStrLen parameter did not indicate a buffer large enough to hold one of the requested output parameters.

LS_AUTHORIZATION_UNAVAILABLE
The specified license certificate could not be located, or you do not have privileges to delete this license certificate.

Notices

NLSGetCertificate lets an application retrieve the actual data comprising a license certificate. This data is in the standard license certificate format. The application needs to parse this data to obtain information about the license certificate or call NLSCertificateTagToMessage to translate the information, on a tag-by-tag basis, to localized message strings for display to the user.


30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.