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

Статья
08/24/2023

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

Синтаксис

NET_API_STATUS NET_API_FUNCTION NetWkstaTransportEnum(
  [in]      LPTSTR  servername,
  [in]      DWORD   level,
  [out]     LPBYTE  *bufptr,
  [in]      DWORD   prefmaxlen,
  [out]     LPDWORD entriesread,
  [out]     LPDWORD totalentries,
  [in, out] LPDWORD resume_handle
);

Параметры

[in] servername

Указатель на строку, указывающую DNS или NetBIOS-имя удаленного сервера, на котором выполняется функция. Если этот параметр имеет значение NULL, используется локальный компьютер.

[in] level

Уровень сведений, запрашиваемых для данных. Этот параметр может иметь следующее значение.

Значение	Значение
0	Возвращает сведения о протоколе транспорта рабочей станции. Параметр bufptr указывает на массив WKSTA_TRANSPORT_INFO_0 структур.

[out] bufptr

Указатель на буфер, который получает данные. Формат этих данных зависит от значения параметра level . Этот буфер выделяется системой и должен быть освобожден с помощью функции NetApiBufferFree . Обратите внимание, что буфер необходимо освободить, даже если функция завершается сбоем с ERROR_MORE_DATA или NERR_BufTooSmall.

[in] prefmaxlen

Предпочтительная максимальная длина возвращаемых данных в байтах. Если указать MAX_PREFERRED_LENGTH, функция выделяет объем памяти, необходимый для данных. Если указать другое значение в этом параметре, это может ограничить количество байтов, возвращаемых функцией. Если размер буфера недостаточен для хранения всех записей, функция возвращает ERROR_MORE_DATA или NERR_BufTooSmall. Дополнительные сведения см. в разделах Буферы функций управления сетью и Длина буфера функции управления сетью.

[out] entriesread

Указатель на значение, которое получает количество фактически перечисляемых элементов.

[out] totalentries

Указатель на значение, которое получает общее количество записей, которые можно было бы перечислить из текущей позиции резюме. Обратите внимание, что приложения должны рассматривать это значение только как подсказку.

[in, out] resume_handle

Указатель на значение, содержащее дескриптор возобновления, используемый для продолжения существующего поиска транспорта рабочей станции. Дескриптор должен быть равен нулю при первом вызове и оставить без изменений для последующих вызовов. Если параметр resumehandle является указателем NULL , дескриптор возобновления не сохраняется.

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

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

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

Код возврата	Описание
ERROR_MORE_DATA	Доступны дополнительные записи. Укажите достаточно большой буфер для получения всех записей.
ERROR_INVALID_LEVEL	Недопустимый параметр level, который указывает, какой уровень сведений о структуре данных доступен. Эта ошибка возвращается, если параметр уровня указан как значение, отличное от нуля.
ERROR_INVALID_PARAMETER	Один или несколько параметров были недопустимы. Эта ошибка возвращается, если параметры bufptr или entriesread являются указателями NULL .
ERROR_NOT_ENOUGH_MEMORY	Недостаточно памяти для обработки запроса.
ERROR_NOT_SUPPORTED	Запрос не поддерживается. Эта ошибка возвращается, если удаленный сервер был указан в параметре servername и этот запрос не поддерживается на удаленном сервере.
NERR_BufTooSmall	Доступны дополнительные записи. Укажите достаточно большой буфер для получения всех записей. Этот код ошибки определен в файле заголовка Lmerr.h .

Требования

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