[This is preliminary documentation and is subject to change.]
Imports members from a CSV file. This function will
import all the valid members into OfficeClip without
giving any warning into a particular group.
Namespace:
OfficeClip.DBLayer.AccountAssembly: OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0
Syntax
C# |
---|
public DataTable ImportMembersFromCsv( ArrayList csvUserList, int selectedOption, bool chkPassword, int groupId, bool isCurrentUserAdmin, int currentUserId ) |
Visual Basic (Declaration) |
---|
Public Function ImportMembersFromCsv ( _ csvUserList As ArrayList, _ selectedOption As Integer, _ chkPassword As Boolean, _ groupId As Integer, _ isCurrentUserAdmin As Boolean, _ currentUserId As Integer _ ) As DataTable |
Visual C++ |
---|
public: DataTable^ ImportMembersFromCsv( ArrayList^ csvUserList, int selectedOption, bool chkPassword, int groupId, bool isCurrentUserAdmin, int currentUserId ) |
Parameters
- csvUserList
- Type: System.Collections..::.ArrayList
ArrayList of OCUserInfo objects containing all the information loaded from the CSV file.
- selectedOption
- Type: System..::.Int32
How the file is imported 1 = Overwrite officeclip information with the file imported. 2 = Do not import names already in officeclip. 3 = Allow duplicates to be merged with the OfficeClip information.
- chkPassword
- Type: System..::.Boolean
If true then send the password to all imported members
- groupId
- Type: System..::.Int32
Id of the group in which the member is being imported.
- isCurrentUserAdmin
- Type: System..::.Boolean
Is the current user an administrator
- currentUserId
- Type: System..::.Int32
The user id of the current user
Return Value
DataTable consisting of name email Address and status of the result of individual import of each member. The DataTable consists of the following columns.- name (System.String)Name of the Member being imported.
- emailAddress (System.String)Email Address of the Member being imported.
- status (System.Int32) This flag indicates the result of individual import into the Group. 0 if the import was successful -2 if any of the invited users could not be imported because an email could not be sent. -3 if any of the invited users could not be imported because an alert could be created. -4 The member can not be imported because accounting is enabled and the account where the user should belong could not be determined. -5 The member can not be imported because accounting is enabled and the user already belongs to another account. -6 The member can not be imported because accounting is enabled and the account has reached the number of users Limit. -7 The member can not be imported because the site license user Limit has been reached.