Getusergroups, Getusergroups 233 – Kofax DM API User Manual

Page 253

Advertising
background image

DM API M

ETHODS

AND

P

ROPERTIES

233

GetUserGroups

GetUserGroups

This method allows you to load a result set with the security groups that
include the network user ID that you specify.

Syntax

PCDNetworkInfo.GetUserGroups( strNetworkType, _

strDomainName, _

strUserID )

Parameters

Returns

The GetUserGroups method returns an

HRESULT

that indicates

whether the method successfully retrieved the list of groups that
include the user as a member.

S_OK

indicates success.

Usage

If the GetUserGroups method was successful, you can use the

GetRowCount

method to set up a loop. Then, use the

NextRow

method

to iterate through the user group list. For each user group, use the

GetValue

method to retrieve the name of each group.

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 that
contains this user.

strUserID

A string that identifies the user within the
network domain.

Advertising