Getgrouplist, Getgrouplist 191 – Kofax DM API User Manual

Page 211

Advertising
background image

DM API M

ETHODS

AND

P

ROPERTIES

191

GetGroupList

GetGroupList

The GetGroupList method populates the result set with a list of the
various groups that exist within a particular domain. There are two
types of groups: distribution and security. Each is an instance of the
Group object, and each contains a collection of attributes that describe
group properties and group members.

Syntax

PCDNetworkInfo.GetGroupList( strNetwkOS, _

strDomainName )

Parameters

Returns

GetGroupList returns an

HRESULT

value that indicates either success or

the numeric error code that identifies the reason why the method did
not execute successfully. This method also populates the result set with
group values.

Example

See the

Example

in the discussion of the

PCDNetworkInfo

object for

sample code that illustrates how you can use the GetGroupList method
in your custom applications.

Related Items

See the

PCDNetworkInfo

object.

See the following properties:

strNetwkOS

A string variable that identifies the network
operating system that is currently running.
Valid values are:

%NI_ADS (Active Directory Services)

%NI_NDS (a Novell network)

%NI_NT (a Microsoft network)

strRootDomain

A string that identifies the root domain.

Advertising