Getuserlist, Getuserlist 23 – Kofax DM API User Manual
Page 255

DM API M
ETHODS
AND
P
ROPERTIES
235
GetUserList
GetUserList
This method retrieves the set of user ID values that exist within the
network domain that you specify.
Syntax
PCDNetworkInfo.GetUserList( strNetworkType, _
strDomainName )
Parameters
Returns
The GetUserList method returns an
HRESULT
that indicates whether
the method successfully retrieved the list of users for the specified
network domain.
S_OK
indicates success.
Usage
If the GetUserList method was successful, you can use the
method to set up a loop. Then, use the
method
to iterate through the list of users. For each user, use the
method to retrieve the user ID value.
You can query the root domain by using the “
%UNDEFINED
” token as
the value for the name of the network domain. Doing this returns the
user IDs on that specific computer, as opposed to all of the users in the
network domain.
strNetworkType
A string that identifies the type of network
operating system that is currently running.
Options are:
•
%NI_ADS
(Active Directory Services)
•
%NI_NDS (a Novell network)
•
%NI_NT (a Microsoft network)
strDomainName
A string that identifies the network domain from
which a user list is to be retrieved.