Función SnmpEntityToStr (winsnmp.h)

[SNMP está disponible para su uso en los sistemas operativos especificados en la sección Requisitos. En versiones posteriores podría modificarse o no estar disponible. En su lugar, use administración remota de Windows, que es la implementación de Microsoft de WS-Man.]

La función SnmpEntityToStr de WinSNMP devuelve una cadena que identifica una entidad de administración snmp.

Sintaxis

SNMPAPI_STATUS SNMPAPI_CALL SnmpEntityToStr(
  [in]  HSNMP_ENTITY entity,
  [in]  smiUINT32    size,
  [out] LPSTR        string
);

Parámetros

[in] entity

Controlar a la entidad de administración snmp de interés.

[in] size

Especifica el tamaño, en bytes, del búfer al que apunta el parámetro de cadena . La aplicación WinSNMP debe asignar un búfer lo suficientemente grande como para contener la cadena de salida.

[out] string

Puntero a un búfer para recibir la cadena terminada en null que identifica la entidad de administración snmp de interés.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es el número de bytes, incluido un byte nulo de terminación, que SnmpEntityToStr devuelve en el búfer de cadenas . Este valor puede ser menor o igual que el valor del parámetro size , pero no puede ser mayor.

Si se produce un error en la función, el valor devuelto se SNMPAPI_FAILURE. Para obtener información de error extendida, llame a SnmpGetLastError. La función SnmpGetLastError puede devolver uno de los siguientes errores.

Comentarios

El valor actual del modo de conversión de entidad y contexto determina el tipo de cadena de salida SnmpEntityToStr devuelve. Para obtener más información, vea Compatibilidad con cadenas de dirección IPX en WinSNMP y Establecer el modo de conversión de entidad y contexto.

Cuando la entidad y el modo de traducción de contexto se SNMPAPI_TRANSLATED y existe una entrada en la base de datos de la implementación, la implementación devuelve el nombre descriptivo asociado de la entidad de administración. Si no existe una entrada para la entidad de administración, SnmpEntityToStr devuelve la dirección de transporte SNMP literal de la entidad de administración.

Cuando el modo de traducción de entidad y contexto está SNMPAPI_UNTRANSLATED_V1 o SNMPAPI_UNTRANSLATED_V2, la implementación de Microsoft WinSNMP también devuelve la dirección de transporte SNMP literal de la entidad de administración.

Requisitos

Consulte también

SnmpStrToEntity

Funciones winSNMP

Introducción a la API winSNMP