Функция MultinetGetConnectionPerformanceA (winnetwk.h)

Статья
11/20/2024

Функция MultinetGetConnectionPerformance возвращает сведения о ожидаемой производительности подключения, используемого для доступа к сетевому ресурсу.

Синтаксис

DWORD MultinetGetConnectionPerformanceA(
  [in]  LPNETRESOURCEA         lpNetResource,
  [out] LPNETCONNECTINFOSTRUCT lpNetConnectInfoStruct
);

Параметры

[in] lpNetResource

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

Член	Значение
lpLocalName	Указатель на буфер, указывающий локальное устройство, например "F:" или "LPT1", который перенаправляется в сетевой ресурс для запроса. Если этот элемент NULL или пустую строку, сетевой ресурс указывается в элементе lpRemoteName. Если этот флаг указывает локальное устройство, lpRemoteName игнорируется.
lpRemoteName	Указатель на сетевой ресурс для запроса. Ресурс должен иметь установленное подключение. Например, если ресурс является файлом на файловом сервере, то открытие файла обеспечит подключение.
lpProvider	Обычно задано значение NULL, но может быть указателем на владельца ресурса (поставщика), если сеть, в которой находится ресурс. Если элемент lpProvider не NULL, система пытается вернуть сведения только о именованной сети.

[out] lpNetConnectInfoStruct

Указатель на структуру NETCONNECTINFOSTRUCT , которая получает данные.

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

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

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

Возвращаемый код	Описание
ERROR_NOT_SUPPORTED	Сетевой ресурс не предоставляет эти сведения.
ERROR_NOT_CONNECTED	Элемент lpLocalName структуры NETRESOURCE, на которую указывает параметр lpNetResource, не указывает перенаправленное устройство или элемент lpRemoteName не указывает имя подключенного ресурса.
ERROR_NO_NET_OR_BAD_PATH	Не удалось завершить операцию, так как сетевой компонент не запущен или не распознается указанное имя ресурса.
ERROR_BAD_DEVICE	Локальное устройство, указанное элементом lpLocalName, является недопустимым.
ERROR_BAD_NET_NAME	Не удается найти имя сети. Эта ошибка возвращается, если элемент lpLocalName структуры NETRESOURCE, на которую указывает параметр lpNetResource, NULL и lpRemoteName член структуры NETRESOURCE, на которую указывает lpNetResource, также или NULL или не удалось распознать ни одной сетью.
ERROR_INVALID_ADDRESS	Попытка получить доступ к недопустимому адресу. Эта ошибка возвращается, если параметры lpNetResource или lpNetConnectInfoStruct были NULL.
ERROR_INVALID_PARAMETER	Был передан недопустимый параметр. Эта ошибка возвращается, если параметр lpNetConnectInfoStruct не указывает на структуру NETCONNECTINFOSTRUCT, в которой элемент cbStructure заполняется соответствующим размером структуры.
ERROR_NO_NETWORK	Сеть недоступна.
ERROR_EXTENDED_ERROR	Произошла ошибка, зависявшая от сети. Чтобы получить описание ошибки, вызовите WNetGetLastError.

Замечания

Функция MultinetGetConnectionPerformance возвращает сведения в структуре NETCONNECTINFOSTRUCT.

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

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

Если UNC-путь указан в элементе lpRemoteName структуры NETRESOURCE, указанной параметром lpNetResource, элемент lpRemoteName должен быть именем каталога, а не именем файла.

Типичным способом использования этой функции будет открытие файла на сетевом сервере (что обеспечит подключение к файлу), вызвать эту функцию и использовать результаты для принятия решений о том, как управлять операцией ввода-вывода файлов. Например, можно решить, следует ли считывать весь файл во временный файл на клиенте или напрямую обращаться к файлу на сервере.

Заметка

Заголовок winnetwk.h определяет MultinetGetConnectionPerformance как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	winnetwk.h
библиотеки	Mpr.lib
DLL	Mpr.dll

См. также

NETCONNECTINFOSTRUCT

NETRESOURCE

Обзор сети Windows (WNet)

Сетевые функции Windows

Поделиться через