Platform SDK: Network Management

NetServerSetInfo

The NetServerSetInfo function sets a server's operating parameters; it can set them individually or collectively. The information is stored in a way that allows it to remain in effect after the system has been reinitialized.

Security Requirements

Only members of the Administrators or Account Operators local group can successfully execute the NetServerSetInfo function.

NET_API_STATUS NetServerSetInfo(
  LPWSTR servername, 
  DWORD level,       
  LPBYTE buf,        
  LPDWORD ParmError  
);

Parameters

servername

[in] Pointer to a Unicode string specifying the name of the remote server on which the function is to execute. The string must begin with \\. If this parameter is NULL, the local computer is used.

level

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

Value	Meaning
100	Specifies the server name and platform information. The buf parameter points to a SERVER_INFO_100 structure.
101	Specifies the server name, type, and associated software. The buf parameter points to a SERVER_INFO_101 structure.
102	Specifies the server name, type, associated software, and other attributes. The buf parameter points to a SERVER_INFO_102 structure.
402	Specifies detailed information about the server. The buf parameter points to a SERVER_INFO_402 structure.
403	Specifies detailed information about the server. The buf parameter points to a SERVER_INFO_403 structure.

In addition, levels 1001-1006, 1009-1011, 1016-1018, 1021, 1022, 1028, 1029, 1037, and 1043 are valid based on the restrictions for LAN Manager systems.

buf

[in] Pointer to a buffer that receives the server information. The format of this data depends on the value of the level parameter.

ParmError

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

Return Values

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.

Value	Meaning
ERROR_ACCESS_DENIED	The user does not have access to the requested information.
ERROR_INVALID_LEVEL	The value specified for the level parameter is invalid.
ERROR_INVALID_PARAMETER	The specified parameter is invalid. For more information, see the following Remarks section.
ERROR_NOT_ENOUGH_MEMORY	Insufficient memory is available.

Remarks

See the end of this Remarks section for a code sample that demonstrates use of the NetServerSetInfo function.

If the NetServerSetInfo function returns ERROR_INVALID_PARAMETER, you can use the ParmError parameter to indicate the first member of the server information structure that is invalid. (A server information structure begins with SERVER_INFO_ and its format is specified by the level parameter.) The following table lists the values that can be returned in the ParmError parameter and the corresponding structure member that is in error. (The prefix sv*_ indicates that the member can begin with multiple prefixes, for example, sv100_ or sv402_.)

Value	Member
SV_PLATFORM_ID_PARMNUM	*sv_platform_id**
SV_NAME_PARMNUM	*sv_name**
SV_VERSION_MAJOR_PARMNUM	*sv_version_major**
SV_VERSION_MINOR_PARMNUM	*sv_version_minor**
SV_TYPE_PARMNUM	*sv_type**
SV_COMMENT_PARMNUM	*sv_comment**
SV_USERS_PARMNUM	*sv_users**
SV_DISC_PARMNUM	*sv_disc**
SV_HIDDEN_PARMNUM	*sv_hidden**
SV_ANNOUNCE_PARMNUM	*sv_announce**
SV_ANNDELTA_PARMNUM	*sv_anndelta**
SV_USERPATH_PARMNUM	*sv_userpath**
SV_ULIST_MTIME_PARMNUM	*sv_ulist_mtime**
SV_GLIST_MTIME_PARMNUM	*sv_glist_mtime**
SV_ALIST_MTIME_PARMNUM	*sv_alist_mtime**
SV_ALERTS_PARMNUM	*sv_alerts**
SV_SECURITY_PARMNUM	*sv_security**
SV_NUMADMIN_PARMNUM	*sv_numadmin**
SV_LANMASK_PARMNUM	*sv_lanmask**
SV_GUESTACC_PARMNUM	*sv_guestacc**
SV_CHDEVQ_PARMNUM	*sv_chdevq**
SV_CHDEVJOBS_PARMNUM	*sv_chdevjobs**
SV_CONNECTIONS_PARMNUM	*sv_connections**
SV_SHARES_PARMNUM	*sv_shares**
SV_OPENFILES_PARMNUM	*sv_openfiles**
SV_SESSOPENS_PARMNUM	*sv_sessopens**
SV_SESSVCS_PARMNUM	*sv_sessvcs**
SV_SESSREQS_PARMNUM	*sv_sessreqs**
SV_OPENSEARCH_PARMNUM	*sv_opensearch**
SV_ACTIVELOCKS_PARMNUM	*sv_activelocks**
SV_NUMREQBUF_PARMNUM	*sv_numreqbuf**
SV_SIZREQBUF_PARMNUM	*sv_sizreqbuf**
SV_NUMBIGBUF_PARMNUM	*sv_numbigbuf**
SV_NUMFILETASKS_PARMNUM	*sv_numfiletasks**
SV_ALERTSCHED_PARMNUM	*sv_alertsched**
SV_ERRORALERT_PARMNUM	*sv_erroralert**
SV_LOGONALERT_PARMNUM	*sv_logonalert**
SV_ACCESSALERT_PARMNUM	*sv_accessalert**
SV_DISKALERT_PARMNUM	*sv_diskalert**
SV_NETIOALERT_PARMNUM	*sv_netioalert**
SV_MAXAUDITSZ_PARMNUM	*sv_maxauditsz**
SV_SRVHEURISTICS_PARMNUM	*sv_srvheuristics**
SV_TIMESOURCE_PARMNUM	*sv_timesource**

The following code sample demonstrates how to set the comment associated with a server using a call to the NetServerSetInfo function, specifying information level 1005 (SERVER_INFO_1005).

#ifndef UNICODE
#define UNICODE
#endif

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

int wmain(int argc, wchar_t *argv[])
{
   DWORD dwLevel = 1005;
   SERVER_INFO_1005 si;
   NET_API_STATUS nStatus;

   if (argc != 3)
   {
      fwprintf(stderr, L"Usage: %s \\\\ServerName Comment\n", argv[0]);
      exit(1);
   }
   //
   // Fill in SERVER_INFO_1005 structure member.
   //
   si.sv1005_comment = argv[2];
   //
   // Call the NetServerSetInfo function, 
   //  specifying level 1005.
   //
   nStatus = NetServerSetInfo(argv[1],
                              dwLevel,
                              (LPBYTE)&si,
                              NULL);
   //
   // Display the result of the call.
   //
   if (nStatus == NERR_Success)
      fwprintf(stderr, L"Comment reset\n", argv[2]);
   else
      fprintf(stderr, "A system error has occurred: %d\n", nStatus);

   return 0;
}

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 server functions. For more information, see IADsComputer.

Requirements