[This is preliminary documentation and is subject to change.]
Updates all the user details i.e. both the users table and the userdetails
table corresponding to a particular group.
Namespace:
OfficeClip.DBLayer.AccountAssembly: OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0
Syntax
C# |
---|
public int SetUserInfo( int loggedInUserId, int userId, int groupId, UserInfo uf, string docIdList, string remDocIdList, ref DateTime updateTime, bool isCurrentUserAdmin ) |
Visual Basic (Declaration) |
---|
Public Function SetUserInfo ( _ loggedInUserId As Integer, _ userId As Integer, _ groupId As Integer, _ uf As UserInfo, _ docIdList As String, _ remDocIdList As String, _ ByRef updateTime As DateTime, _ isCurrentUserAdmin As Boolean _ ) As Integer |
Visual C++ |
---|
public: int SetUserInfo( int loggedInUserId, int userId, int groupId, UserInfo^ uf, String^ docIdList, String^ remDocIdList, DateTime% updateTime, bool isCurrentUserAdmin ) |
Parameters
- loggedInUserId
- Type: System..::.Int32
The user who is currently logged in.
- userId
- Type: System..::.Int32
The incoming user id of the user.
- groupId
- Type: System..::.Int32
The group id to determine which userdetail record has to be updated.
- uf
- Type: OfficeClip.BusinessLayer.Account..::.UserInfo
The incoming business layer object which contains all the user/userdetail data. UserInfo
- docIdList
- Type: System..::.String
The documentid list of the photos if any to be added.
- remDocIdList
- Type: System..::.String
The documentid list of the photos if any to be removed.
- updateTime
- Type: System..::.DateTime%
The update time
- isCurrentUserAdmin
- Type: System..::.Boolean
Is the logged in user an administrator
Return Value
0 if successful, -1 in case of a general error, -2 when the email Address being updated is already used by another user.
Remarks
OfficeClip allows to change the email Address (which happens to be the primary login id
into the OfficeClip system.). Hence this method checks whether if the the email
Address being updated is already taken up by another user. If so, -2 is returned
as error message.