Функция NetWkstaUserSetInfo (lmwksta.h)

Статья
08/24/2023

Функция NetWkstaUserSetInfo задает пользовательские сведения об элементах конфигурации рабочей станции.

Синтаксис

NET_API_STATUS NET_API_FUNCTION NetWkstaUserSetInfo(
        LMSTR   reserved,
  [in]  DWORD   level,
  [in]  LPBYTE  buf,
  [out] LPDWORD parm_err
);

Параметры

reserved

Для этого параметра необходимо задать нулевое значение.

[in] level

Указывает уровень информации о данных. Этот параметр может принимать одно из указанных ниже значений.

Значение	Значение
1	Указывает сведения о рабочей станции, включая имя текущего пользователя и домены, к которым она обращается. Параметр buf указывает на структуру WKSTA_USER_INFO_1 .
1101	Указывает домены, просматриваемые рабочей станцией. Параметр buf указывает на структуру WKSTA_USER_INFO_1101 .

[in] buf

Указатель на буфер, указывающий данные. Формат этих данных зависит от значения параметра level . Дополнительные сведения см. в разделе Буферы функций управления сетью.

[out] parm_err

Указатель на значение, получающее индекс первого параметра, который вызывает ошибку ERROR_INVALID_PARAMETER. Если этот параметр имеет значение NULL, индекс не возвращается при ошибке.

Возвращаемое значение

Если функция выполняется успешно, возвращаемое значение будет NERR_Success.

Если функция завершается сбоем, возвращаемое значение может быть одним из следующих кодов ошибок.

Код возврата	Описание
ERROR_INVALID_LEVEL	Недопустимый параметр level .
ERROR_INVALID_PARAMETER	Один из параметров функции недопустим.

Доменные имена в wkui1101_oth_domains элементе структуры WKSTA_USER_INFO_1101 разделяются пробелами. Пустой список является допустимым. Указатель NULL означает, что член остается без изменений. Элемент wkui1101_oth_domains нельзя задать с помощью MS-DOS. При задании этого элемента NetWkstaUserSetInfo отклоняет запрос, если список имен был недопустимым или если не удалось добавить имя в один или несколько сетевых адаптеров, управляемых системой.

Если функция NetWkstaUserSetInfo возвращает ERROR_INVALID_PARAMETER, можно использовать параметр parm_err , чтобы указать недопустимый член пользовательской информационной структуры рабочей станции. (Структура сведений о пользователе рабочей станции начинается с WKSTA_USER_INFO_ и ее формат задается параметром level .) В следующей таблице перечислены значения, которые могут быть возвращены в параметре parm_err , и соответствующий элемент структуры, который находится в ошибке. (Префикс wkui*_ указывает, что элемент может начинаться с нескольких префиксов, например wkui0_ или wkui1_.)

Значение	Член
WKSTA_OTH_DOMAINS_PARMNUM	wkui*_oth_domains

Примеры

В следующем примере кода показано, как задать пользовательские сведения для рабочей станции с помощью вызова функции NetWkstaUserSetInfo , указав уровень сведений 1101 ( WKSTA_USER_INFO_1101).

#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 = 1101;
   WKSTA_USER_INFO_1101 wui;
   NET_API_STATUS nStatus;

   if (argc != 2)
   {
      fwprintf(stderr, L"Usage: %s OtherDomains\n", argv[0]);
      exit(1);
   }
   //
   // Fill in the WKSTA_USER_INFO_1101 structure member.
   //
   wui.wkui1101_oth_domains = argv[1];
   //
   // Call the NetWkstaUserSetInfo function
   //  to change the list of domains browsed by
   //  the workstation; specify level 1101.
   //
   nStatus = NetWkstaUserSetInfo(NULL,
                                 dwLevel,
                                 (LPBYTE)&wui,
                                 NULL);
   //
   // Display the result of the call.
   //
   if (nStatus == NERR_Success)
      fprintf(stderr, "Workstation user information has been changed\n");
   else
      fprintf(stderr, "A system error has occurred: %d\n", nStatus);

   return 0;
}

Требования


Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	lmwksta.h (включая Lm.h)
Библиотека	Netapi32.lib
DLL	Netapi32.dll