Perforce .NET API
Perforce.P4
Repository Class
Repository Methods
AddOrUpdateServerLicense Method
CreateBranchSpec Method
CreateChangelist Method
CreateClient Method
CreateDepot Method
CreateGroup Method
CreateJob Method
CreateLabel Method
CreateStream Method
CreateUser Method
DeleteBranchSpec Method
DeleteChangelist Method
DeleteClient Method
DeleteCounter Method
DeleteDepot Method
DeleteGroup Method
DeleteJob Method
DeleteLabel Method
DeleteStream Method
DeleteUser Method
Dispose Method
GetBranchSpec Method
GetBranchSpecs Method
GetChangelist Method
GetChangelists Method
GetClient Method
GetClientMetadata Method
GetClients Method
GetCounter Method
GetCounters Method
GetDepot Method
GetDepotDirs Method
GetDepotFileDiffs Method
GetDepotFiles Method
GetDepots Method
GetFileAnnotations Method
GetFileContents Method
GetFileContentsEx Method
GetFileDiffs Method
GetFileHistory Method
GetFileLineMatches Method
GetFileMetaData Method
GetFiles Method
GetFixes Method
GetFormSpec Method
GetGroup Method
GetGroups Method
GetJob Method
GetJobs Method
GetLabel Method
GetLabels Method
GetMaxProtectionAccess Method
GetOpenedFiles Method
GetProtectionEntries Method
GetProtectionTable Method
GetReviewers Method
GetServerLicenseInformation Method
GetServerMetaData Method
GetStream Method
GetStreamLog Method
GetStreamMetaData Method
GetStreams Method
GetSubmittedIntegrations Method
GetTriggerTable Method
GetTypeMap Method
GetUser Method
GetUsers Method
NewChangelist Method
RenameClient Method
TagFiles Method
UpdateBranchSpec Method
UpdateChangelist Method
UpdateClient Method
UpdateDepot Method
UpdateGroup Method
UpdateJob Method
UpdateLabel Method
UpdateStream Method
UpdateSubmittedChangelist Method
UpdateUser Method
Click or drag to resize

RepositoryGetGroups Method

Get a list of groups from the repository

Namespace:  Perforce.P4
Assembly:  p4api.net (in p4api.net.dll) Version: 2023.2.258.5793
Syntax
Copy
public IList<Group> GetGroups(
	Options options,
	params string[] groups
)

Parameters

options
Type: Perforce.P4Options
options for the groups commandGroupsCmdOptions
groups
Type: SystemString
groups

Return Value

Type: IListGroup
A list containing the matching groups
Remarks

p4 help groups

groups -- List groups (of users)

p4 groups [-m max] [-v] [group]
p4 groups [-m max] [-i [-v]] user | group
p4 groups [-m max] [-g | -u | -o] name

The first form lists all user groups defined in the server, or just
the specified group.

The second form displays subgroup relationships. If a user argument is
specified, only groups containing that user are displayed. If a group
argument is specified, only groups containing the group are displayed.

The third form is useful when there are groups and users with the
same name, or when requesting all groups owned by a certain user.

The -i flag also displays groups that the user or group belongs to
indirectly by means of membership in subgroups.

The -m max flag limits output to the specified number of groups.

The -v flag displays the MaxResults, MaxScanRows, MaxLockTime, and
Timeout values for each group that is displayed.

The -g flag indicates that the 'name' argument is a group.

The -u flag indicates that the 'name' argument is a user.

The -o flag indicates that the 'name' argument is an owner.

Examples
To get the first 10 groups:
Copy
Options opts = new Options(GroupsCmdFlags.None, 10);
IList<Group> groups = _repository.getGroups(opts);
To get all groups that 'Bob' belongs to, including subgroups:
Copy
Options opts = new Options(GroupsCmdFlags.IncludeIndirect, -1);
IList<Group> groups = _repository.getGroups(opts, "Bob");
To get all the groups with the MaxResults, MaxScanRows, MaxLockTime, and Timeout values for the specified group:
Copy
Options opts = new Options(GroupsCmdFlags.IncludeAllValues, -1);
IList<Group> groups = _repository.getGroups(opts);
See Also