NLSCertificateTagToMessage(3nw)
NLSCertificateTagToMessage --
presents license certificate information to the user in a more clear and organized manner
Synopsis
LS_STATUS_CODE NLSCertificateTagToMessage(
LS_VOID
licenseCertificate,
LS_ULONG licenseCertificateLength,
LS_ULONG maxStrLen,
LS_STR
messageString,
LS_ULONG
tagNumber);
Description
The parameters are as follows:
- licenseCertificate
-
(IN) Points to a buffer that contains the data describing a valid license certificate. NLSGetCertificate can be utilized to retrieve this value.
- licenseCertificateLength
-
(IN) Specifies the overall length of the license certificate (in bytes) pointed to by licenseCertificate.
- maxStringLen
-
(IN) Specifies the maximum length of the string (in bytes) that can be placed into messageString on return from this function.
- messageString
-
(OUT) Points to a buffer in which to place the localized message string on return. On output, it is a text message string describing the tag and its parameters.
- tagNumber
-
(IN/OUT) Points to a tag number (in the order they appear in the certificate) for which the translation should be performed. To view all tags in a license certificate, this value
should be initialized to zero on the first call to this function, and opaquely passed back 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
-
The maxStrLen parameter did not indicate a buffer large enough to hold one of the requested output parameters.
Notices
The LSP performs this translation for the application; the application does not require any specific knowledge of the fields contained in the license certificate to perform this
task.
30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.