NLSGetEntry(3nw)
NLSGetEntry --
views all the individual components of a transaction
Synopsis
LS_STATUS_CODE NLSGetEntry(
LS_HANDLE
transactionHandle,
LS_TRANS_ENTRY
transactionEntry,
LS_ULONG
index);
Description
The parameters are as follows:
- transactionHandle
-
(IN) Points to the handle (returned by NLSGetTransaction) that points to a set of entries.
- transactionEntry
-
(OUT) Points to an individual entry in the transaction. The entry is a structure of the following format:
struct LS_TRANS_ENTRY_TAG
{
LS_STR *actionName;
LS_ULONG time;
LS_STATUS_CODE actionResult;
LS_ULONG numUnits;
LS_STR *userLoggedMessage;
} LS_TRANS_ENTRY;
NOTE:
actionName
and userLoggedMessage
are allocated by the NLSAPI library. These values should be freed when the entry is no longer needed.
- index
-
(IN/OUT) Used to iterate through the entire list of transactions. This 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_RESOURCES_UNAVAILABLE
-
Insufficient resources (such as memory) available to complete request.
- LS_BAD_HANDLE
-
Specified handle does not describe an existing transaction handle.
- LS_BAD INDEX
-
There are no more entries after the specified index.
Notices
NLSGetEntry views all the individual components of a transaction. This lets you determine how long license units were held, and it provides a detailed history of any
errors that occurred in the process of obtaining and holding license units. Most transaction entries are generated by applications calling LSAPI functions; however, system errors
and license certificate installations also generate transactions.
The user associated with the current connection must be security-equivalent to the creator of the transaction handle.
30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.