Adds a new user to the Visual Guard repository.
Namespace: Novalys.VisualGuard.Security.MembershipAssembly: Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2017.0.101.17 (2017.0.101.17)
Syntax
C# |
---|
public VGMembershipUser CreateUser( string username, string password, string email, string passwordQuestion, string passwordAnswer, bool isApproved, string comment, out VGMembershipCreateStatus status ) |
Visual Basic |
---|
Public Function CreateUser ( username As String, password As String, email As String, passwordQuestion As String, passwordAnswer As String, isApproved As Boolean, comment As String, <OutAttribute> ByRef status As VGMembershipCreateStatus ) As VGMembershipUser |
Parameters
- username
- Type: System..::..String
The user name for the new user.
- password
- Type: System..::..String
The password for the new user.
- Type: System..::..String
The e-mail address for the new user.
- passwordQuestion
- Type: System..::..String
The password-question value for the membership user.
- passwordAnswer
- Type: System..::..String
The password-answer value for the membership user.
- isApproved
- Type: System..::..Boolean
A Boolean that indicates whether the new user is approved to log on.
- comment
- Type: System..::..String
Specific information for the user.
- status
- Type: Novalys.VisualGuard.Security.Membership..::..VGMembershipCreateStatus%
A VGMembershipCreateStatus indicating that the user was created successfully or the reason creation failed.
Return Value
Type: VGMembershipUserA VGMembershipUser object for the newly created user. null value when the creation fails.
Remarks
When a default role is defined for your application, the default role is automatically granted to the user. You can define a default role to your application in the Visual Guard console.
Exceptions
Exception | Condition |
---|---|
System.Security..::..SecurityException | The current user does not have enough privileges to use Membership API. The Membership access level of the application must be sufficient to allows this action or the 'Membership Manager' role must be granted to the user by using the Visual Guard console. |