NetUserModalsSet function (lmaccess.h)

Article
10/13/2021

The NetUserModalsSet function sets global information for all users and global groups in the security database, which is the security accounts manager (SAM) database or, in the case of domain controllers, the Active Directory.

Syntax

NET_API_STATUS NET_API_FUNCTION NetUserModalsSet(
  [in]  LPCWSTR servername,
  [in]  DWORD   level,
  [in]  LPBYTE  buf,
  [out] LPDWORD parm_err
);

Parameters

[in] servername

Pointer to a constant string that specifies the DNS or NetBIOS name of the remote server on which the function is to execute. If this parameter is NULL, the local computer is used.

[in] level

Specifies the information level of the data. This parameter can be one of the following values.

Value	Meaning
0	Specifies global password parameters. The buf parameter points to a USER_MODALS_INFO_0 structure.
1	Specifies logon server and domain controller information. The buf parameter points to a USER_MODALS_INFO_1 structure.
2	Specifies the domain name and identifier. The buf parameter points to a USER_MODALS_INFO_2 structure.
3	Specifies lockout information. The buf parameter points to a USER_MODALS_INFO_3 structure.
1001	Specifies the minimum allowable password length. The buf parameter points to a USER_MODALS_INFO_1001 structure.
1002	Specifies the maximum allowable password age. The buf parameter points to a USER_MODALS_INFO_1002 structure.
1003	Specifies the minimum allowable password age. The buf parameter points to a USER_MODALS_INFO_1003 structure.
1004	Specifies forced logoff information. The buf parameter points to a USER_MODALS_INFO_1004 structure.
1005	Specifies the length of the password history. The buf parameter points to a USER_MODALS_INFO_1005 structure.
1006	Specifies the role of the logon server. The buf parameter points to a USER_MODALS_INFO_1006 structure.
1007	Specifies domain controller information. The buf parameter points to a USER_MODALS_INFO_1007 structure.

[in] buf

Pointer to the buffer that specifies the data. The format of this data depends on the value of the level parameter. For more information, see Network Management Function Buffers.

[out] parm_err

Pointer to a value that receives the index of the first member of the information structure that causes ERROR_INVALID_PARAMETER. If this parameter is NULL, the index is not returned on error. For more information, see the following Remarks section.

Return value

If the function succeeds, the return value is NERR_Success.

If the function fails, the return value can be one of the following error codes.

Return code	Description
ERROR_ACCESS_DENIED	The user does not have access to the requested information.
ERROR_INVALID_PARAMETER	The specified parameter is invalid. For more information, see the following Remarks section.
NERR_InvalidComputer	The computer name is invalid.
NERR_UserNotFound	The user name could not be found.

Remarks

If you are programming for Active Directory, you may be able to call certain Active Directory Service Interface (ADSI) methods to achieve the same functionality you can achieve by calling the network management user modal functions. For more information, see IADsDomain.

If you call this function on a domain controller that is running Active Directory, access is allowed or denied based on the access control list (ACL) for the securable object. The default ACL permits only Domain Admins and Account Operators to call this function. On a member server or workstation, only Administrators and Power Users can call this function. For more information, see Security Requirements for the Network Management Functions. For more information on ACLs, ACEs, and access tokens, see Access Control Model.

The security descriptor of the Domain object is used to perform the access check for this function. Typically, callers must have write access to the entire object for calls to this function to succeed.

If the NetUserModalsSet function returns ERROR_INVALID_PARAMETER, you can use the parm_err parameter to indicate the first member of the information structure that is invalid. (The information structure begins with USER_MODALS_INFO_ and its format is specified by the level parameter.) The following table lists the values that can be returned in the parm_err parameter and the corresponding structure member that is in error. (The prefix usrmod*_ indicates that the member can begin with multiple prefixes, for example, usrmod2_ or usrmod1002_.)

Value	Member
MODALS_MIN_PASSWD_LEN_PARMNUM	usrmod*_min_passwd_len
MODALS_MAX_PASSWD_AGE_PARMNUM	usrmod*_max_passwd_age
MODALS_MIN_PASSWD_AGE_PARMNUM	usrmod*_min_passwd_age
MODALS_FORCE_LOGOFF_PARMNUM	usrmod*_force_logoff
MODALS_PASSWD_HIST_LEN_PARMNUM	usrmod*_password_hist_len
MODALS_ROLE_PARMNUM	usrmod*_role
MODALS_PRIMARY_PARMNUM	usrmod*_primary
MODALS_DOMAIN_NAME_PARMNUM	usrmod*_domain_name
MODALS_DOMAIN_ID_PARMNUM	usrmod*_domain_id
MODALS_LOCKOUT_DURATION_PARMNUM	usrmod*_lockout_duration
MODALS_LOCKOUT_OBSERVATION_WINDOW_PARMNUM	usrmod*_lockout_observation_window
MODALS_LOCKOUT_THRESHOLD_PARMNUM	usrmod*_lockout_threshold

Examples

The following code sample demonstrates how to set the global information for all users and global groups with a call to the NetUserModalsSet function. The sample fills in the members of the USER_MODALS_INFO_0 structure and calls NetUserModalsSet, specifying information level 0.

#ifndef UNICODE
#define UNICODE
#endif
#pragma comment(lib, "netapi32.lib")

#include <stdio.h>
#include <windows.h> 
#include <lm.h>

int wmain(int argc, wchar_t *argv[])
{
   DWORD dwLevel = 0;
   USER_MODALS_INFO_0 ui;
   NET_API_STATUS nStatus;
   LPTSTR pszServerName = NULL;

   if (argc > 2)
   {
      fwprintf(stderr, L"Usage: %s [\\\\ServerName]\n", argv[0]);
      exit(1);
   }
   // The server is not the default local computer.
   //
   if (argc == 2)
      pszServerName = (LPTSTR) argv[1];
   //
   // Fill in the USER_MODALS_INFO_0 structure.
   //
   ui.usrmod0_min_passwd_len = 0;
   ui.usrmod0_max_passwd_age = (86400 * 30);
   ui.usrmod0_min_passwd_age = 0;
   ui.usrmod0_force_logoff = TIMEQ_FOREVER; // never force logoff
   ui.usrmod0_password_hist_len = 0;
   //
   // Call the NetUserModalsSet function; specify level 0.
   //
   nStatus = NetUserModalsSet((LPCWSTR) pszServerName,
                              dwLevel,
                              (LPBYTE)&ui,
                              NULL);
   //
   // If the call succeeds, inform the user.
   //
   if (nStatus == NERR_Success)
      fwprintf(stderr, L"Modals information set successfully on %s\n", argv[1]);
   //
   // Otherwise, print the system error.
   //
   else
      fprintf(stderr, "A system error has occurred: %d\n", nStatus);

   return 0;
}

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	lmaccess.h (include Lm.h)
Library	Netapi32.lib
DLL	Netapi32.dll

Share via