Release 10.1A: OpenEdge Development:
Progress Dynamics Managers API Reference

> ## checkUser

> This procedure authenticates the passed-in user or company identities.

> Because you always want to use the latest information to authenticate the user who is trying to log in, this procedure does not cache. The following checks are made on the user details entered:

> 1. Checks if the user is valid and, if it is not, returns an error stating that an invalid login name was specified.

> 2. Checks if the account has been disabled and, if it has, returns an error.

> 3. Checks if the category of user has been disabled and, if it has, returns an error.

> 4. If a password was entered, checks that the password is valid for the user. If the password is not valid, then the fail count is updated on the user record. If this exceeds the maximum retries, the account is additionally disabled and the retries reset back to 0.

> 5. If a valid password is entered, the fail count is reset, and the login details updated on the user.

> 6. If the user password has expired, then this fact is returned to the login window. The login window should prompt for a new password before proceeding with the login. If this fails, the login is aborted.

> Location: af\app\afsecmngrp.i

> Parameters:

> `INPUT pcLoginName AS CHARACTER`

> The user login name.

> `INPUT pcPassword AS CHARACTER`

> The encoded user password.

> `INPUT pdCompanyObj AS DECIMAL`

> The login company `obj` specified.

> `INPUT pdLanguageObj AS DECIMAL`

> The language `obj` specified.

> `OUTPUT pdUserObj AS DECIMAL`

> The login user object number.

> `OUTPUT pcUserName AS CHARACTER`

> The user full name.

> `OUTPUT pcUserEmail AS CHARACTER`

> The user e-mail.

> `OUTPUT pcOrganisationCode AS CHARACTER`

> The organization code.

> `OUTPUT pcOrganisationName AS CHARACTER`

> The organization name.

> `OUTPUT pcOrganisationShort AS CHARACTER`

> The organization short name.

> `OUTPUT pcLanguageName AS CHARACTER`

> The language name.

> `OUTPUT pcError AS CHARACTER`

> Any failure reason (standard Progress Dynamics-formatted error).

> Notes: None

> Examples: See the `authenticateUser` function in `ry\app\ryreqsrvrp.p`.

Copyright © 2005 Progress Software Corporation www.progress.com Voice: (781) 280-4000 Fax: (781) 280-4095