USER_INFO_3 structure (lmaccess.h)
The USER_INFO_3 structure contains information about a user account, including the account name, password data, privilege level, the path to the user's home directory, relative identifiers (RIDs), and other user-related network statistics.
Syntax
typedef struct _USER_INFO_3 {
LPWSTR usri3_name;
LPWSTR usri3_password;
DWORD usri3_password_age;
DWORD usri3_priv;
LPWSTR usri3_home_dir;
LPWSTR usri3_comment;
DWORD usri3_flags;
LPWSTR usri3_script_path;
DWORD usri3_auth_flags;
LPWSTR usri3_full_name;
LPWSTR usri3_usr_comment;
LPWSTR usri3_parms;
LPWSTR usri3_workstations;
DWORD usri3_last_logon;
DWORD usri3_last_logoff;
DWORD usri3_acct_expires;
DWORD usri3_max_storage;
DWORD usri3_units_per_week;
PBYTE usri3_logon_hours;
DWORD usri3_bad_pw_count;
DWORD usri3_num_logons;
LPWSTR usri3_logon_server;
DWORD usri3_country_code;
DWORD usri3_code_page;
DWORD usri3_user_id;
DWORD usri3_primary_group_id;
LPWSTR usri3_profile;
LPWSTR usri3_home_dir_drive;
DWORD usri3_password_expired;
} USER_INFO_3, *PUSER_INFO_3, *LPUSER_INFO_3;
Members
usri3_name
Type: LPWSTR
A pointer to a Unicode string that specifies the name of the user account. For the NetUserSetInfo function, this member is ignored. For more information, see the following Remarks section.
usri3_password
Type: LPWSTR
A pointer to a Unicode string that specifies the password for the user identified by the usri3_name member. The length cannot exceed PWLEN bytes. The NetUserEnum and NetUserGetInfo functions return a NULL pointer to maintain password security.
By convention, the length of passwords is limited to LM20_PWLEN characters.
usri3_password_age
Type: DWORD
The number of seconds that have elapsed since the usri3_password member was last changed. The NetUserAdd and NetUserSetInfo functions ignore this member.
usri3_priv
Type: DWORD
The level of privilege assigned to the usri3_name member. The NetUserAdd and NetUserSetInfo functions ignore this member. This member can be one of the following values. For more information about user and group account rights, see Privileges.
Value | Meaning |
---|---|
|
Guest |
|
User |
|
Administrator |
usri3_home_dir
Type: LPWSTR
A pointer to a Unicode string specifying the path of the home directory of the user specified by the usri3_name member. The string can be NULL.
usri3_comment
Type: LPWSTR
A pointer to a Unicode string that contains a comment to associate with the user account. The string can be a NULL string, or it can have any number of characters before the terminating null character.
usri3_flags
Type: DWORD
This member can be one or more of the following values.
Note that setting user account control flags may require certain privileges and control access rights. For more information, see the Remarks section of the NetUserSetInfo function.
Value | Meaning |
---|---|
|
The logon script executed. This value must be set. |
|
The user's account is disabled. |
|
The home directory is required. This value is ignored. |
|
No password is required. |
|
The user cannot change the password. |
|
The account is currently locked out. You can call the NetUserSetInfo function to clear this value and unlock a previously locked account. You cannot use this value to lock a previously unlocked account. |
|
The password should never expire on the account. |
|
The user's password is stored under reversible encryption in the Active Directory. |
|
Marks the account as "sensitive"; other users cannot act as delegates of this user account. |
|
Requires the user to log on to the user account with a smart card. |
|
Restrict this principal to use only Data Encryption Standard (DES) encryption types for keys. |
|
This account does not require Kerberos preauthentication for logon. |
|
The account is enabled for delegation. This is a security-sensitive setting; accounts with this option enabled should be tightly controlled. This setting allows a service running under the account to assume a client's identity and authenticate as that user to other remote servers on the network. |
|
The user's password has expired.
Windows 2000: This value is not supported. |
|
The account is trusted to authenticate a user outside of the Kerberos security package and delegate that user through constrained delegation. This is a security-sensitive setting; accounts with this option enabled should be tightly controlled. This setting allows a service running under the account to assert a client's identity and authenticate as that user to specifically configured services on the network.
Windows XP/2000: This value is not supported. |
The following values describe the account type. Only one value can be set. You cannot change the account type using the NetUserSetInfo function.
usri3_script_path
Type: LPWSTR
A pointer to a Unicode string specifying the path for the user's logon script file. The script file can be a .CMD file, an .EXE file, or a .BAT file. The string can also be NULL.
usri3_auth_flags
Type: DWORD
The user's operator privileges.
For the NetUserGetInfo and NetUserEnum functions, the appropriate value is returned based on the local group membership. If the user is a member of Print Operators, AF_OP_PRINT is set. If the user is a member of Server Operators, AF_OP_SERVER is set. If the user is a member of the Account Operators, AF_OP_ACCOUNTS is set. AF_OP_COMM is never set.
The NetUserAdd and NetUserSetInfo functions ignore this member.
This member can be one or more of the following values.
usri3_full_name
Type: LPWSTR
A pointer to a Unicode string that contains the full name of the user. This string can be a NULL string, or it can have any number of characters before the terminating null character.
usri3_usr_comment
Type: LPWSTR
A pointer to a Unicode string that contains a user comment. This string can be a NULL string, or it can have any number of characters before the terminating null character.
usri3_parms
Type: LPWSTR
A pointer to a Unicode string that is reserved for use by applications. This string can be a NULL string, or it can have any number of characters before the terminating null character. Microsoft products use this member to store user configuration information. Do not modify this information.
usri3_workstations
Type: LPWSTR
Important
You should no longer use usri3_workstations. Instead, you can control sign-in access to workstations by configuring the User Rights Assignment settings (Allow log on locally and Deny log on locally, or Allow log on through Remote Desktop Services and Deny log on through Remote Desktop Services).
A pointer to a Unicode string that contains the names of workstations from which the user can log on. As many as eight workstations can be specified; the names must be separated by commas. If you do not want to restrict the number of workstations, use a NULL string. To disable logons from all workstations to this account, set the UF_ACCOUNTDISABLE value in the usri3_flags member.
usri3_last_logon
Type: DWORD
The date and time when the last logon occurred. This value is stored as the number of seconds that have elapsed since 00:00:00, January 1, 1970, GMT. This member is ignored by the NetUserAdd and NetUserSetInfo functions.
This member is maintained separately on each backup domain controller (BDC) in the domain. To obtain an accurate value, you must query each BDC in the domain. The last logon occurred at the time indicated by the largest retrieved value.
usri3_last_logoff
Type: DWORD
This member is currently not used.
The date and time when the last logoff occurred. This value is stored as the number of seconds that have elapsed since 00:00:00, January 1, 1970, GMT. A value of zero indicates that the last logoff time is unknown.
This member is maintained separately on each backup domain controller (BDC) in the domain. To obtain an accurate value, you must query each BDC in the domain. The last logoff occurred at the time indicated by the largest retrieved value.
usri3_acct_expires
Type: DWORD
The date and time when the account expires. This value is stored as the number of seconds elapsed since 00:00:00, January 1, 1970, GMT. A value of TIMEQ_FOREVER indicates that the account never expires.
usri3_max_storage
Type: DWORD
The maximum amount of disk space the user can use. Specify USER_MAXSTORAGE_UNLIMITED to use all available disk space.
usri3_units_per_week
Type: DWORD
The number of equal-length time units into which the week is divided. This value is required to compute the length of the bit string in the usri3_logon_hours member.
This value must be UNITS_PER_WEEK for LAN Manager 2.0. This element is ignored by the NetUserAdd and NetUserSetInfo functions.
For service applications, the units must be one of the following values: SAM_DAYS_PER_WEEK, SAM_HOURS_PER_WEEK, or SAM_MINUTES_PER_WEEK.
usri3_logon_hours
Type: PBYTE
A pointer to a 21-byte (168 bits) bit string that specifies the times during which the user can log on. Each bit represents a unique hour in the week, in Greenwich Mean Time (GMT).
The first bit (bit 0, word 0) is Sunday, 0:00 to 0:59; the second bit (bit 1, word 0) is Sunday, 1:00 to 1:59; and so on. Note that bit 0 in word 0 represents Sunday from 0:00 to 0:59 only if you are in the GMT time zone. In all other cases you must adjust the bits according to your time zone offset (for example, GMT minus 8 hours for Pacific Standard Time).
Specify a NULL pointer in this member when calling the NetUserAdd function to indicate no time restriction. Specify a NULL pointer when calling the NetUserSetInfo function to indicate that no change is to be made to the times during which the user can log on.
usri3_bad_pw_count
Type: DWORD
The number of times the user tried to log on to the account using an incorrect password. A value of – 1 indicates that the value is unknown. Calls to the NetUserAdd and NetUserSetInfo functions ignore this member.
This member is replicated from the primary domain controller (PDC); it is also maintained on each backup domain controller (BDC) in the domain. To obtain an accurate value, you must query each BDC in the domain. The number of times the user tried to log on using an incorrect password is the largest value retrieved.
usri3_num_logons
Type: DWORD
The number of times the user logged on successfully to this account. A value of – 1 indicates that the value is unknown. Calls to the NetUserAdd and NetUserSetInfo functions ignore this member.
This member is maintained separately on each backup domain controller (BDC) in the domain. To obtain an accurate value, you must query each BDC in the domain. The number of times the user logged on successfully is the sum of the retrieved values.
usri3_logon_server
Type: LPWSTR
A pointer to a Unicode string that contains the name of the server to which logon requests are sent. Server names should be preceded by two backslashes (\). To indicate that the logon request can be handled by any logon server, specify an asterisk (\*) for the server name. A NULL string indicates that requests should be sent to the domain controller.
For Windows servers, NetUserGetInfo and NetUserEnum return \*. The NetUserAdd and NetUserSetInfo functions ignore this member.
usri3_country_code
Type: DWORD
The country/region code for the user's language of choice.
usri3_code_page
Type: DWORD
The code page for the user's language of choice.
usri3_user_id
Type: DWORD
The relative ID (RID) of the user. The RID is determined by the Security Account Manager (SAM) when the user is created. It uniquely defines the user account to SAM within the domain. The NetUserAdd and NetUserSetInfo functions ignore this member. For more information about RIDs, see SID Components.
usri3_primary_group_id
Type: DWORD
The RID of the Primary Global Group for the user. When you call the NetUserAdd function, this member must be DOMAIN_GROUP_RID_USERS (defined in WinNT.h). When you call NetUserSetInfo, this member must be the RID of a global group in which the user is enrolled. For more information, see Well-Known SIDs.
usri3_profile
Type: LPWSTR
A pointer to a Unicode string that specifies a path to the user's profile. This value can be a NULL string, a local absolute path, or a UNC path.
usri3_home_dir_drive
Type: LPWSTR
A pointer to a Unicode string that specifies the drive letter assigned to the user's home directory for logon purposes.
usri3_password_expired
Type: DWORD
The password expiration information.
The NetUserGetInfo and NetUserEnum functions return zero if the password has not expired (and nonzero if it has).
When you call NetUserAdd or NetUserSetInfo, specify a nonzero value in this member to inform users that they must change their password at the next logon. To turn off this message, call NetUserSetInfo and specify zero in this member. Note that you cannot specify zero to negate the expiration of a password that has already expired.
Remarks
The USER_INFO_3 structure can be used with the NetUserAdd, NetUserEnum, NetUserSetInfo, and NetUserGetInfo functions.
User account names are limited to 20 characters and group names are limited to 256 characters. In addition, account names cannot be terminated by a period and they cannot include commas or any of the following printable characters: ", /, , [, ], :, |, <, >, +, =, ;, ?, *. Names also cannot include characters in the range 1-31, which are nonprintable.
Note that the USER_INFO_4 structure supersedes the USER_INFO_3 structure on Windows XP and later. It is recommended that applications use the USER_INFO_4 structure instead of the USER_INFO_3 structure with the NetUserAdd, NetUserSetInfo, and NetUserGetInfo functions on Windows XP and later.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows 2000 Professional [desktop apps only] |
Minimum supported server | Windows 2000 Server [desktop apps only] |
Header | lmaccess.h (include Lm.h) |