[This is preliminary documentation and is subject to change.]
Validates whether the user can be registered based on the values filled up by the user on the registration form.
Namespace:
OfficeClip.DBLayer.AccountAssembly: OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0
Syntax
C# |
---|
public int ValidateUserRegistration( string emailAddress, string ldapAccountName, string groupName, string grpType ) |
Visual Basic (Declaration) |
---|
Public Function ValidateUserRegistration ( _ emailAddress As String, _ ldapAccountName As String, _ groupName As String, _ grpType As String _ ) As Integer |
Visual C++ |
---|
public: int ValidateUserRegistration( String^ emailAddress, String^ ldapAccountName, String^ groupName, String^ grpType ) |
Parameters
- emailAddress
- Type: System..::.String
Email Address of the user.
- ldapAccountName
- Type: System..::.String
Ldap Account Name of the user if LDAP authentication is enabled.
- groupName
- Type: System..::.String
Name of the group being created by the user.
- grpType
- Type: System..::.String
Type of the group being created by the user.
Return Value
Integer flag indicating whether the validation was successful or not. Following is the list of possible values returned and their meanings. 0 = Successful -1 = Group or Orgnaization name already exists. -2 = User is already registered. -3 = LDAP Account name already exists (If LDAP Authentication is enabled). -4 = LDAP Account Name entered could not be authenticated on the LDAP Server. (If LDAP Authentication is enabled).
Remarks
Please make sure that none of these values are not empty. The validation for emptyness should be done before calling
this method.
Also note that only organization and Group type should be passed as argument during registration.