GetUsersByUserName gets all the users of the portal whose username matches a provided filter expression

Namespace: DotNetNuke.Security.Membership
Assembly: DotNetNuke (in DotNetNuke.dll)

Syntax

C#
public override ArrayList GetUsersByUserName(
	int portalId,
	string userNameToMatch,
	int pageIndex,
	int pageSize,
	ref int totalRecords,
	bool includeDeleted,
	bool superUsersOnly
)
Visual Basic
Public Overrides Function GetUsersByUserName ( 
	portalId As Integer,
	userNameToMatch As String,
	pageIndex As Integer,
	pageSize As Integer,
	ByRef totalRecords As Integer,
	includeDeleted As Boolean,
	superUsersOnly As Boolean
) As ArrayList

Parameters

portalId
Type: System..::..Int32
The Id of the Portal
userNameToMatch
Type: System..::..String
The username to use to find a match.
pageIndex
Type: System..::..Int32
The page of records to return.
pageSize
Type: System..::..Int32
The size of the page
totalRecords
Type: System..::..Int32%
The total no of records that satisfy the criteria.
includeDeleted
Type: System..::..Boolean
Include deleted users.
superUsersOnly
Type: System..::..Boolean
Only select super users.

Return Value

An ArrayList of UserInfo objects.

Remarks

If all records are required, (ie no paging) set pageSize = -1

See Also