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

Статья
03/08/2023

Функция 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 , являются только оценочной. Сетевой трафик и маршрутизация могут повлиять на точность возвращаемых результатов.

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

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

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

Примечание

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

Требования


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

См. также раздел

NETCONNECTINFOSTRUCT

NETRESOURCE

Общие сведения о сети Windows (WNet)

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