Функция SnmpMgrCtl (mgmtapi.h)

Статья
08/24/2023

[SNMP доступен для использования в операционных системах, указанных в разделе Требования. В последующих версиях он может быть изменен или недоступен. Вместо этого используйте удаленное управление Windows, которое является реализацией WS-Man майкрософт.]

Функция SnmpMgrCtl задает операционный параметр, связанный с сеансом SNMP. Эта функция является элементом API управления SNMP.

Синтаксис

BOOL SNMP_FUNC_TYPE SnmpMgrCtl(
  [in]  LPSNMP_MGR_SESSION session,
  [in]  DWORD              dwCtlCode,
  [in]  LPVOID             lpvInBuffer,
  [in]  DWORD              cbInBuffer,
  [out] LPVOID             lpvOUTBuffer,
  [out] DWORD              cbOUTBuffer,
  [out] LPDWORD            lpcbBytesReturned
);

Параметры

[in] session

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

[in] dwCtlCode

Задает значение (код элемента управления), определяющее выполняемую операцию.

В настоящее время MGMCTL_SETAGENTPORT является единственным поддерживаемым кодом элемента управления. Установка этого кода позволяет приложению управления SNMP отправлять запросы к удаленному агенту, который "прослушивает" запросы диспетчера SNMP через произвольный порт. Дополнительные сведения см. в описании параметров lpvInBuffer и cbInBuffer .

[in] lpvInBuffer

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

При указании кода элемента управления MGMCTL_SETAGENTPORT этот параметр должен указывать на целое число без знака, указывающее номер порта, на котором удаленный агент будет "прослушивать" запросы диспетчера SNMP. Номер порта должен быть в порядке байтов узла.

[in] cbInBuffer

Задает размер (в байтах) буфера, на который указывает параметр lpvInBuffer .

При указании кода элемента управления MGMCTL_SETAGENTPORT этот параметр равен sizeof(UINT).

[out] lpvOUTBuffer

Указатель на буфер, который получает выходные данные операции.

[out] cbOUTBuffer

Задает размер (в байтах) буфера, на который указывает параметр lpvOutBuffer .

[out] lpcbBytesReturned

Указатель на переменную, которая получает фактический размер (в байтах) данных, хранящихся в буфере, на который указывает параметр lpvOutBuffer .

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

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

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

Код возврата	Описание
SNMP_MGMTAPI_INVALID_CTL	Параметр dwCtlCode не указывает допустимый код элемента управления.
SNMP_MGMTAPI_INVALID_SESSION	Параметр сеанса не указывает допустимый сеанс SNMP.
SNMP_MGMTAPI_INVALID_BUFFER	Один или несколько параметров lpvInBuffer, lpvOutBuffer или lpcbBytesRequired недопустимы, либо параметр cbInBuffer или cbOutBuffer слишком мал.

Требования


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

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

Функции SNMP

Обзор протокола SNMP

SnmpMgrOpen

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