| Name | Type | Optional | ByRef | Description |
|---|---|---|---|---|
| clientId | String | The Client Id or the Client's Web User Id. | ||
| password | String | The Client's Web Password. | ||
| audit | Boolean | Optional | Indicates whether to create an Audit record detailing access details and also update this Client's Failed Login details if unsuccessful or Last Login details if successful. If omitted, a value of True is assumed. | |
| failedReason | isefinClientLoginFailReason | Optional | ByRef | <para> The reason the login failed. </para> <para> Check this only if this method returns False. A value of Unknown indicates that the business layer's ErrorMessage should be used. </para> <para> Although the ErrorMessage will also contain these details, this allows the business layer consumer to display custom error messages and not rely on the built-in error details. </para> If omitted, a value of isefinClientLoginFailReason.Unknown is assumed. |
| client | finClient | Optional | ByRef | The Client object containing details of the Client being validated. If omitted, a value of Nothing is assumed. |
| testMode | Boolean | Optional | If True, then the login will be validated and attempted but nothing will be committed. If audit is True, then Audit logs will still be created. If False, then the login will be fully validated, attempted, and committed to the database. If omitted, a value of False is assumed. |
A Boolean value indicating success.