Función SnmpListen (winsnmp.h)

Artículo
03/15/2023

[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 la administración remota de Windows, que es la implementación de Microsoft de WS-Man.]

La función SnmpListen de WinSNMP registra una aplicación WinSNMP como agente SNMP. Una aplicación de agente llama a esta función para informar a la implementación de Microsoft WinSNMP de que una entidad actuará en el rol de un agente SNMP. Una aplicación también llama a esta función para informar a la implementación cuando una entidad ya no actúe en este rol. La función SnmpListen es un elemento de la API winSNMP, versión 2.0.

Sintaxis

SNMPAPI_STATUS SNMPAPI_CALL SnmpListen(
  [in] HSNMP_ENTITY   hEntity,
  [in] SNMPAPI_STATUS lStatus
);

Parámetros

[in] hEntity

Controle a la entidad WinSNMP para notificar cuándo la implementación de Microsoft WinSNMP recibe un mensaje de solicitud SNMP entrante (PDU). Este parámetro identifica la aplicación del agente. Para obtener más información, vea las secciones Comentarios y Valores devueltos siguientes.

Al llamar a la función SnmpCreateSession , puede especificar si la implementación debe usar un mensaje de notificación de ventana o una función de SNMPAPI_CALLBACK para notificar a la aplicación cuando haya disponible un mensaje SNMP o un evento asincrónico.

[in] lStatus

Especifica una variable de entero largo sin signo que indica si la entidad WinSNMP identificada por el parámetro hEntity actúa en un rol de agente SNMP o si ya no actúa en este rol. Este parámetro puede ser uno de los valores siguientes.

Valor	Significado
SNMPAPI_ON	La entidad WinSNMP especificada funciona en un rol de agente.
SNMPAPI_OFF	La entidad WinSNMP especificada no funciona en un rol de agente.

Pasar un valor de SNMPAPI_OFF libera los recursos asignados a la entidad y el puerto asignados. Para obtener más información, vea la sección Comentarios que se muestra más adelante.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es SNMPAPI_SUCCESS.

Si se produce un error en la función, el valor devuelto es 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_ENTITY_INVALID	El parámetro hEntity no es válido. Este parámetro debe ser un identificador devuelto por una llamada anterior a la función SnmpStrToEntity .
SNMPAPI_MODE_INVALID	El parámetro lStatus no es válido.
SNMPAPI_NOOP	La entidad especificada por el parámetro hEntity ya funciona en el rol de un agente SNMP.
SNMPAPI_TL_RESOURCE_ERROR	Hay un error en la capa de transporte de red. No se pudo crear un socket para la entidad especificada por el parámetro hEntity .
SNMPAPI_TL_OTHER	Error en la capa de transporte de red al intentar enlazar un socket para la entidad especificada por el parámetro hEntity .
SNMPAPI_OTHER_ERROR	Error desconocido o indefinido.

Comentarios

Cuando se especifica una entidad, se especifica explícitamente la familia de direcciones, la dirección de interfaz y el puerto de la entidad. Esto se debe a que WinSNMP asigna estos atributos a cada entidad winSNMP como resultado de una llamada a la función SnmpStrToEntity . La implementación usa la configuración de dirección y puerto asignada actualmente a la entidad especificada por el parámetro hEntity cuando envía notificaciones a la aplicación del agente. Para obtener más información, vea SnmpSetPort.

Al llamar a la función SnmpClose para una sesión de WinSNMP y la función SnmpCleanup para una aplicación WinSNMP, debe liberar todos los puertos asociados a las aplicaciones de agente de WinSNMP.

Para obtener más información sobre las aplicaciones de administración de SNMP y las aplicaciones de agente, consulte Registro de una aplicación de agente SNMP y Acerca de SNMP.

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