Función SnmpStrToEntity (winsnmp.h)

Artículo
03/04/2024

[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 SnmpStrToEntity de WinSNMP devuelve un identificador para obtener información sobre una entidad de administración snmp específica de la implementación de Microsoft WinSNMP.

Sintaxis

HSNMP_ENTITY SNMPAPI_CALL SnmpStrToEntity(
  [in] HSNMP_SESSION session,
  [in] LPCSTR        string
);

Parámetros

[in] session

Controla la sesión de WinSNMP.

[in] string

Puntero a una cadena terminada en null que identifica la entidad de administración snmp de interés. El valor actual del modo de conversión de entidad y contexto determina la manera en que SnmpStrToEntity interpreta la cadena de entrada como se indica a continuación.

Modo de traducción de entidad/contexto	Significado
SNMPAPI_TRANSLATED	La implementación interpreta el parámetro de cadena como un nombre descriptivo. La implementación traduce el nombre en sus componentes SNMPv1 o SNMPv2C mediante la base de datos de la implementación.
SNMPAPI_UNTRANSLATED_V1	La implementación interpreta el parámetro de cadena como una dirección de transporte SNMP literal.
SNMPAPI_UNTRANSLATED_V2	La implementación interpreta el parámetro de cadena como una dirección de transporte SNMP literal.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es un identificador de la entidad de administración snmp de interés.

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.

Código devuelto	Descripción
SNMPAPI_NOT_INITIALIZED	La función SnmpStartup no se completó correctamente.
SNMPAPI_ALLOC_ERROR	Error durante la asignación de memoria.
SNMPAPI_SESSION_INVALID	El parámetro session no es válido.
SNMPAPI_ENTITY_UNKNOWN	La cadena de entidad no es válida.
SNMPAPI_OTHER_ERROR	Se produjo un error desconocido o no definido.

Comentarios

El valor actual del modo de traducción de entidad y contexto determina la manera en que SnmpStrToEntity interpreta la cadena de entrada que identifica la entidad de administración de interés. 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.

La aplicación WinSNMP debe llamar a la función SnmpFreeEntity para liberar el identificador de entidad asignado por la función SnmpStrToEntity . Para obtener más información, consulte Conceptos de winSNMP Administración de datos.

La función SnmpStrToEntity devuelve un identificador de entidad válido que una aplicación WinSNMP puede usar como srcEntity o el parámetro dstEntity en varias funciones winSNMP. Estas funciones incluyen las funciones SnmpSendMsg, SnmpRecvMsg, SnmpRegister, SnmpEncodeMsg y SnmpDecodeMsg .

La implementación devuelve la entidad actual y el modo de traducción de contexto en el parámetro nTranslateMode de la función SnmpStartup . Una aplicación WinSNMP puede cambiar la configuración del modo de conversión de entidad y contexto con una llamada a la función SnmpSetTranslateMode .

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winsnmp.h
Library	Wsnmp32.lib
Archivo DLL	Wsnmp32.dll