SYNOPSIS

int MGOwantuwnetid (Uwnetid *uwn, Validation *val, int opts);

DESCRIPTION

The MGOwantuwnetid() function reserves a uwnetid and sets up the appropriate affiliations. A wanted uwnetid will automatically be recycled after a couple of days if not permanently added via MGOadduwnetid(). Validation information is passed through val. The uwnetid and associated information is passed through uwn. The required and optional fields are as follows:

• val.validid (r)
• val.source_code (r)
• val.lname (o)
• val.pac (o)
• val.birthdate (o)

• uwn.uwnetid (r)
• uwn.uid (o)
• uwn.luid (o)
• uwn.account (o)

val.validid is the validation id. val.source_code is the validation source reference code. val.lname is the last name. val.pac is the private access code. val.birthdate is the birthdate in YYYY-MM-DD form. uwn.uwnetid is the uwnetid name. If a "*" is placed at the end of the name, a unique uwnetid consisting of the name plus the next number in sequence (beginning with 1) will be generated. If a high uid is wanted, then the uwn.uid field should be set. Specify a positive value, or 0 to have one chosen at random. The same applies for a low uid (uwn.luid). uwn.account is the account name. It typically is set to the encrypted employee number, student number, or some other unique value. opts can be one or more of:

• 0 - Default behavior
• 1 - Force completion (overrides MGO_E_VNV or MGO_E_VAU error)

Note: Upon successful return, the uwn.uwnetid and uwn.uid fields will be set their resultant values.

RETURN VALUE

Returns 1 upon success or -1 if an error occurred (in which case MGOerrno and MGOerrmsg are set appropriately).

ERRORS

• MGO_E_MAR - One or more of the required arguments were missing
• MGO_E_IAR - Invalid or ambiguous argument
• MGO_E_PMD - Permission denied. See access control
• MGO_E_VAL - No such validation source reference code
• MGO_E_VNV - The given validation information is not valid
• MGO_E_VAU - The validation id is already affiliated with another uwnetid
• MGO_E_UIU - Uwnetid is already in use
• MGO_E_SQL - An SQL error occurred. See MGOerrmsg for details

AUTHENTICATION LEVEL

wmango

SEE ALSO

MGOadduwnetid(), MGOgetvalidations(), MGOselrvalsource(), MGOzero()