Document revision date: 30 March 2001

## OpenVMS System Services Reference Manual

Previous | Contents | Index

Because the encryption algorithm is a byte in length, the buffer length field in the item descriptor should specify 1 (byte).

Symbolic Name | Description
--- | ---
UAI$C_AD_II | Uses a CRC algorithm and returns a longword hash value. It was used in VAX VMS releases prior to Version 2.0.
UAI$C_PURDY | Uses a Purdy algorithm over salted input. It expects a blank-padded user name and returns a quadword hash value. This algorithm was used during VAX VMS Version 2.0 field test.
UAI$C_PURDY_V | Uses the Purdy algorithm over salted input. It expects a variable-length user name and returns a quadword hash value. This algorithm was used in VMS releases prior to Version 5.4.
UAI$C_PURDY_S | Uses the Purdy algorithm over salted input. It expects a variable-length user name and returns a quadword hash value. This is the current algorithm that the operating system uses for all new password changes.

#### UAI$_ENCRYPT2

Returns one of the following values identifying the encryption algorithm for the secondary password:

- UAI$C_AD_II
- UAI$C_PURDY
- UAI$C_PURDY_V
- UAI$C_PURDY_S

Because the encryption algorithm is a byte in length, the buffer length field in the item descriptor should specify 1 byte.

#### UAI$_ENQLM

Returns the lock queue limit.

Because this decimal number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes).

#### UAI$_EXPIRATION

Returns, as a quadword absolute time value, the expiration date and time of the account.

Because the absolute time value is a quadword in length, the buffer length field in the item descriptor should specify 8 (bytes).

#### UAI$_FILLM

Returns the open file limit.

Because this decimal number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes).

#### UAI$_FLAGS

Returns, as a longword bit vector, the various login flags set for the user.

Each flag is represented by a bit. The $UAIDEF macro defines the following symbolic names for these flags:

Symbolic Name | Description
--- | ---
UAI$V_AUDIT | All actions are audited.
UAI$V_AUTOLOGIN | User can only log in to terminals defined by the Automatic Login facility (ALF).
UAI$V_CAPTIVE | User is restricted to captive account.
UAI$V_DEFCLI | User is restricted to default command interpreter.
UAI$V_DISACNT | User account is disabled. Same as /FLAG = DISUSER qualifier in AUTHORIZE.
UAI$V_DISCTLY | User cannot use Ctrl/Y.
UAI$V_DISFORCE_PWD_CHANGE | User will not be forced to change expired passwords at login.
UAI$V_DISIMAGE | User cannot issue the RUN or MCR commands or use the foreign command mechanism in DCL.
UAI$V_DISMAIL | Announcement of new mail is suppressed.
UAI$V_DISPWDDIC | Automatic checking of user-selected passwords against the system dictionary is disabled.
UAI$V_DISPWDHIS | Automatic checking of user-selected passwords against previously used passwords is disabled.
UAI$V_DISRECONNECT | User cannot reconnect to existing processes.
UAI$V_DISREPORT | User will not receive last login messages.
UAI$V_DISWELCOME | User will not receive the login welcome message.
UAI$V_EXTAUTH | User is considered to be externally authenticated by their external user ID and password, and not by the SYSUAF user ID and password. The SYSUAF record is still used for checking login restrictions and quotas and for creating the user's OpenVMS process profile.
UAI$V_GENPWD | User is required to use generated passwords.
UAI$V_LOCKPWD | SET PASSWORD command is disabled.
UAI$V_MIGRATEPWD | User's SYSUAF password has been set using AUTHORIZE or SYS$SETUAI and is likely to be inconsistent with the user's external user password. If password migration is enabled, the system will attempt to update the external authentication service the next time the user attempts a login.
UAI$V_NOMAIL | Mail delivery to user is disabled.
UAI$V_PWD_EXPIRED | Primary password is expired.
UAI$V_PWD2_EXPIRED | Secondary password is expired.
UAI$V_RESTRICTED | User is limited to operating under a restricted account. (Refer to the OpenVMS Guide to System Security for a description of restricted and captive accounts.)

#### UAI$_JTQUOTA

Returns the initial byte quota with which the jobwide logical name table is to be created.

Because this quota is a longword decimal number, the buffer length field in the item descriptor should specify 4 (bytes).

#### UAI$_LASTLOGIN_I

Returns, as a quadword absolute time value, the date of the last interactive login.

#### UAI$_LASTLOGIN_N

Returns, as a quadword absolute time value, the date of the last noninteractive login.

#### UAI$_LGICMD

Returns, as an OpenVMS RMS file specification, the name of the default login command file.

Because a file specification can include up to 63 characters in addition to a size-byte prefix, the buffer length field of the item descriptor should specify 64 (bytes).

#### UAI$_LOCAL_ACCESS_P

Returns, as a 3-byte value, the range of times during which local interactive access is permitted for primary days. Each bit set represents a 1-hour period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. to midnight. For each hour the bit is set to 0, access is allowed. For each hour the bit is set to 1, access is denied.

The buffer length field in the item descriptor should specify 3 (bytes).

#### UAI$_LOCAL_ACCESS_S

Returns, as a 3-byte value, the range of times during which batch access is permitted for secondary days. Each bit set represents a 1-hour period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. to midnight. For each hour the bit is set to 0, access is allowed. For each hour the bit is set to 1, access is denied.

The buffer length field in the item descriptor should specify 3 (bytes).

#### UAI$_LOGFAILS

Returns the count of login failures.

Because this decimal number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes).

#### UAI$_MAXACCTJOBS

Returns the maximum number of batch, interactive, and detached processes that can be active at one time for all users of the same account. The value 0 represents an unlimited number.

Because this decimal number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes).

#### UAI$_MAXDETACH

Returns the detached process limit. A value of 0 represents an unlimited number.

Because this decimal number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes).

#### UAI$_MAXJOBS

Returns the active process limit. A value of 0 represents an unlimited number.

Because this decimal number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes).

#### UAI$_NETWORK_ACCESS_P

Returns, as a 3-byte value, the range of times during which network access is permitted for primary days. Each bit set represents a 1-hour period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. to midnight. For each hour the bit is set to 0, access is allowed. For each hour the bit is set to 1, access is denied.

The buffer length field in the item descriptor should specify 3 (bytes).

#### UAI$_NETWORK_ACCESS_S

Returns, as a 3-byte value, the range of times during which network access is permitted for secondary days. Each bit set represents a 1-hour period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. to midnight. For each hour the bit is set to 0, access is allowed. For each hour the bit is set to 1, access is denied.

The buffer length field in the item descriptor should specify 3 (bytes).

#### UAI$_OWNER

Returns, as a character string, the name of the owner of the account.

Because the owner name can include up to 31 characters in addition to a size-byte prefix, the buffer length field of the item descriptor should specify 32 (bytes).

#### UAI$_PBYTLM

Returns the paged buffer I/O byte count limit.

Because the paged buffer I/O byte count limit is a longword decimal number, the buffer length field in the item descriptor should specify 4 (bytes).

#### UAI$_PGFLQUOTA

Returns the paging file quota in pages (on VAX systems) or in blocks (on Alpha systems).

Because the paging file quota is a longword decimal number, the buffer length field in the item descriptor should specify 4 (bytes).

#### UAI$_PRCCNT

Returns the subprocess creation limit.

Because the subprocess creation limit is a longword decimal number, the buffer length field in the item descriptor should specify 4 (bytes).

#### UAI$_PRI

Returns the default base priority in the range 0 through 31.

Because this decimal number is a byte in length, the buffer length field in the item descriptor should specify 1 (byte).

#### UAI$_PRIMEDAYS

Returns, as a longword bit vector, the primary and secondary days of the week.

Each bit represents a day of the week, with the bit clear representing a primary day and the bit set representing a secondary day. The $UAIDEF macro defines the following symbolic names for these bits:

> UAI$V_MONDAY
> UAI$V_TUESDAY
> UAI$V_WEDNESDAY
> UAI$V_THURSDAY
> UAI$V_FRIDAY
> UAI$V_SATURDAY
> UAI$V_SUNDAY

#### UAI$_PRIV

Returns, as a quadword value, the names of the privileges the user holds.

Because this value is a quadword in length, the buffer length field in the item descriptor should specify 8 (bytes).

#### UAI$_PWD

Returns, as a quadword value, the hashed primary password of the user.

Because this value is a quadword in length, the buffer length field in the item descriptor should specify 8 (bytes).

#### UAI$_PWD_DATE

Returns, as a quadword absolute time value, the date of the last password change.

Because this value is a quadword in length, the buffer length field in the item descriptor should specify 8 (bytes).

A value of --1 indicates that the password is marked as preexpired.

#### UAI$_PWD_LENGTH

Returns the minimum password length.

Because this decimal number is a byte in length, the buffer length field in the item descriptor should specify 1 (byte).

#### UAI$_PWD_LIFETIME

Returns, as a quadword delta time value, the password lifetime.

Because this value is a quadword in length, the buffer length field in the item descriptor should specify 8 (bytes).

A quadword of 0 means that none of the password mechanisms will take effect.

#### UAI$_PWD2

Returns, as a quadword value, the hashed secondary password of the user.

Because this value is a quadword in length, the buffer length field in the item descriptor should specify 8 (bytes).

#### UAI$_PWD2_DATE

Returns, as a quadword absolute time value, the last date the secondary password was changed.

Because this value is a quadword in length, the buffer length field in the item descriptor should specify 8 (bytes).

A value of --1 indicates that the password could be marked as preexpired.

#### UAI$_QUEPRI

Returns the maximum job queue priority.

Because this decimal number is a byte in length, the buffer length field in the item descriptor should specify 1 (byte).

#### UAI$_REMOTE_ACCESS_P

Returns, as a 3-byte value, the range of times during which remote interactive access is permitted for primary days. Each bit set represents a 1-hour period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. to midnight.

The buffer length field in the item descriptor should specify 3 (bytes).

#### UAI$_REMOTE_ACCESS_S

Returns, as a 3-byte value, the range of times during which remote interactive access is permitted for secondary days. Each bit set represents a 1-hour period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. to midnight.

The buffer length field in the item descriptor should specify 3 (bytes).

#### UAI$_SALT

Returns the random password salt.

Because this decimal number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes).

#### UAI$_SHRFILLM

Returns the shared file limit.

Because this decimal number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes).

#### UAI$_TQCNT

Returns the timer queue entry limit.

Because this decimal number is a word in length, the buffer length field in the item descriptor should specify 2 (bytes).

#### UAI$_UIC

Returns, as a longword, the user identification code (UIC). For the format of the UIC, see the OpenVMS Guide to System Security.

#### UAI$_USER_DATA

Returns up to 255 bytes of information from the user data area of the system user authorization file (SYSUAF).

You can read information written to the user data area from previous versions of the operating system as long as the information written adheres to the guidelines described in the OpenVMS Guide to System Security.

#### UAI$_WSEXTENT

Returns the working set extent, in pages (on VAX systems) or pagelets (on Alpha systems), for the user of the specified queue or job.

Because the working set extent is a longword decimal number, the buffer length field in the item descriptor should specify 4 (bytes).

#### UAI$_WSQUOTA

Returns the working set quota, in pages (on VAX systems) or pagelets (on Alpha systems), for the specified user.

Because this quota is a longword decimal number, the buffer length field in the item descriptor should specify 4 (bytes).

### Description

> The Get User Authorization Information service returns authorization information about a specified user.

> The contxt value returned by $GETUAI should never be used as a value to the $SETUAI system service.

> You examine for a valid login by checking the bits of UAI$V_PWD_EXPIRED and UAI$V_DISUSER, and by doing a comparison of the UAI$_PWD_DATE item code against the UAI$_PWD_LIFETIME item code.

> The UAI$V_PWD_EXPIRED bit is only set by the system when the bit UAI$V_DISFORCE_PWD_CHANGE is set in the user's SYSUAF record and the comparison between the UAI$_PWD_DATE and UAI$_PWD_LIFETIME indicates a password is past its valid life.

> During a normal login when the UAI$V_DISFORCE_PWD_CHANGE bit is not set, the system compares VAI$_PWD_DATE against UAI$_PWD_LIFETIME and, if expired, forces the user to change the password. With this configuration, the UAI$V_PWD_EXPIRED bit is not set.

> During a normal login when the VAI$V_DISFORCE_PWD_EXPIRED is set, the system compares UAI$_PWD_DATE against UAI$_PWD_LIFETIME and, if expired, sets the UAI$_PWD_EXPIRED bit and notifies the user to change the now-expired password. In this case, the user is not forced to change the password.

> Required Access or Privileges

> Use the following list to determine the privileges required to use the $GETUAI service:

> - BYPASS or SYSPRV---Allows access to any record in the user authorization file (UAF).
> - GRPPRV---Allows access to any record in the UAF whose UIC group matches that of the requester.
> - No privilege---Allows access to any UAF record whose UIC matches that of the requester.
>   You need read access to the UAF to look up any information other than your own.

> Required Quota

> None

> Related Services

> $SETUAI

### Condition Values Returned

> SS$_NORMAL | The service completed successfully.
> SS$_ACCVIO | The item list or input buffer cannot be read by the caller; or the return length buffer, output buffer, or status block cannot be written by the caller.
> SS$_BADPARAM | The function code is invalid; the item list contains an invalid item code; a buffer descriptor has an invalid length; or the reserved parameter has a nonzero value.
> SS$_NOGRPPRV | The user does not have the privileges required to examine the authorization information for other members of the UIC group.
> SS$_NOSYSPRV | The user does not have the privileges required to examine the authorization information associated with the user or for users outside of the user's UIC group.
> RMS$_RSZ | The UAF record is smaller than required; the caller's SYSUAF is probably corrupt.

This service can also return OpenVMS RMS status codes associated with operations on indexed files. For example, an inquiry about a nonexistent account returns RMS$_RNF, record not found status. For a description of RMS status codes that are returned by this service, refer to the OpenVMS Record Management Services Reference Manual.

## $GETUTC

> Returns the current time in 128-bit UTC format.

> On Alpha systems, this service accepts 64-bit addresses.

### Format

> SYS$GETUTC utcadr

### C Prototype

> int sys$getutc (unsigned int *utcadr [4]);

### Arguments

> #### utcadr

> OpenVMS usage: | coordinated universal time
> type: | utc_date_time
> access: | write only
> mechanism: | by 32- or 64-bit reference (Alpha)
> mechanism: | by 32-bit reference (VAX)

> The 128-bit time value to be returned.

### Description

> The Get UTC Time service returns the current system time in 128-bit UTC format. System time is updated every 10 milliseconds.

> On Alpha systems, the frequency at which system time is updated varies, depending on the clock frequency of the Alpha processor.

> Required Access or Privileges

> None

> Required Quota

> None

> Related Services

> $ASCUTC, $BINUTC, $NUMUTC, $TIMCON

### Condition Values Returned

> SS$_NORMAL | The service completed successfully.
> SS$_ACCVIO | The argument was not accessible for write in the mode of the caller.

## $GET_ALIGN_FAULT_DATA (Alpha Only)

> On Alpha systems, obtains data from the user image alignment fault buffer if buffered user alignment fault data reporting has been enabled.

> This service accepts 64-bit addresses.

### Format

> SYS$GET_ALIGN_FAULT_DATA buffer ,buffer_size ,return_size

### C Prototype

> int sys$get_align_fault_data (void *buffer, int buffer_size, int *return_size);

### Arguments

> #### buffer

> OpenVMS usage: | address
> type: | longword (unsigned)
> access: | read/write
> mechanism: | by 32- or 64-bit reference

> The user buffer in which the alignment fault data is to be stored. The buffer is the 32- or 64-bit address of this user buffer.

> #### buffer_size

> OpenVMS usage: | byte count
> type: | longword (signed)
> access: | read
> mechanism: | by value

> The size, in bytes, of the buffer specified by the buffer argument.

> #### return_size

> OpenVMS usage: | longword_signed
> type: | longword (signed)
> access: | write
> mechanism: | by 32- or 64-bit reference

> The amount of data, in bytes, stored in the buffer. The return_size argument is the 32- or 64-bit address of a naturally aligned longword into which the service returns the size of the buffer. The return_size is set to 0 if there is no data in the buffer.

### Description

> The Get Alignment Fault Data service obtains data from the user image alignment fault buffer if buffered user alignment fault data reporting has been enabled.

> When buffered user alignment fault data reporting is enabled, the operating system writes each alignment fault into a user-defined buffer. The user must poll this buffer periodically to read the data.

> The user must call the $START_ALIGN_FAULT_REPORT service to enable buffered user alignment fault data reporting.

> For more information about buffered user alignment fault data reporting, see the $START_ALIGN_FAULT_REPORT system service.

> Required Access or Privileges

> None

> Required Quota

> None

> Related Services

> $GET_SYS_ALIGN_FAULT_DATA, $INIT_SYS_ALIGN_FAULT_REPORT, $PERM_DIS_ALIGN_FAULT_REPORT, $PERM_REPORT_ALIGN_FAULT, $START_ALIGN_FAULT_REPORT, $STOP_ALIGN_FAULT_REPORT, $STOP_SYS_ALIGN_FAULT_REPORT

### Condition Values Returned

> SS$_NORMAL | The service completed successfully.
> SS$_ACCVIO | The buffer named in the buffer argument is not accessible.
> SS$_AFR_NOT_ENABLED | Alignment fault reporting has not been enabled.
> SS$_BADPARAM | The buffer size is smaller than the minimum defined by the AFR$K_USER_LENGTH symbol.

Previous | Next | Contents | Index

| privacy and legal statement |
4527PRO_056.HTML