Функция SnmpOidToStr (winsnmp.h)

Статья
08/27/2023

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

Функция SnmpOidToStr WinSNMP преобразует внутреннее двоичное представление идентификатора объекта SNMP в формат его пунктирной числовой строки, например в "1.2.3.4.5.6".

Синтаксис

SNMPAPI_STATUS SNMPAPI_CALL SnmpOidToStr(
  [in]  smiLPCOID srcOID,
  [in]  smiUINT32 size,
  [out] LPSTR     string
);

Параметры

[in] srcOID

Указатель на структуру smiOID с идентификатором объекта для преобразования.

[in] size

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

[out] string

Указатель на буфер для получения идентификатора преобразованного строкового объекта, задающего сущность управления SNMP.

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

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

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

Код возврата	Описание
SNMPAPI_NOT_INITIALIZED	Функция SnmpStartup не была успешно завершена.
SNMPAPI_ALLOC_ERROR	Произошла ошибка при выделении памяти.
SNMPAPI_SIZE_INVALID	Недопустимый параметр size . Этот параметр не может быть равен нулю; Он должен указывать размер буфера, на который указывает строковый параметр.
SNMPAPI_OID_INVALID	Недопустимый параметр srcOID . Дополнительные сведения см. в следующем разделе Примечаний.
SNMPAPI_OUTPUT_TRUNCATED	Длина выходного буфера недостаточна.
SNMPAPI_OTHER_ERROR	Произошла неизвестная или неопределенная ошибка.

Приложение WinSNMP рекомендуется указать с параметром size строковый буфер длины MAXOBJIDSTRSIZE (1408 байт). Это гарантирует, что выходной буфер будет достаточно большим для хранения преобразованной строки. Так как преобразованная строка обычно меньше MAXOBJIDSTRSIZE, приложение WinSNMP может скопировать преобразованную строку в буфер меньшего размера. Затем приложение может повторно использовать или освободить память, выделенную для начального буфера. Дополнительные сведения см. в статье Основные понятия Управление данными WinSNMP.

Требования


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

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

SnmpStrToOid

Функции WinSNMP

Общие сведения об API WinSNMP

smiOID