Compartir a través de


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

Una aplicación WinSNMP llama a la función SnmpCancelMsg para solicitar que la implementación de Microsoft WinSNMP cancele los intentos de retransmisión y las notificaciones de tiempo de espera de un mensaje de solicitud SNMP. La función SnmpCancelMsg es un elemento de la API winSNMP, versión 2.0.

Sintaxis

SNMPAPI_STATUS SNMPAPI_CALL SnmpCancelMsg(
  [in] HSNMP_SESSION session,
  [in] smiINT32      reqId
);

Parámetros

[in] session

Controle la sesión de WinSNMP que envió el mensaje de solicitud SNMP (PDU) que se va a cancelar.

[in] reqId

Especifica un valor numérico único que identifica la PDU de interés. Este parámetro debe coincidir con el identificador de solicitud (request_id) del parámetro PDU especificado en la llamada inicial de la aplicación a la función SnmpSendMsg .

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_SESSION_INVALID
El parámetro session no es válido.
SNMPAPI_PDU_INVALID
El parámetro reqId no identifica un mensaje pendiente para la sesión especificada.
SNMPAPI_NOT_INITIALIZED
La función SnmpStartup no se completó correctamente.
SNMPAPI_ALLOC_ERROR
Error durante la asignación de memoria.
SNMPAPI_OTHER_ERROR
Error desconocido o indefinido.

Comentarios

Llamar a la función SnmpCancelMsg equivale a llamar a la función SnmpSetRetransmitMode , para un mensaje SNMP específico, con el modo de retransmisión igual a SNMPAPI_OFF.

Para obtener más información, vea Cancelar retransmisión y administrar la directiva de retransmisión.

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

Consulte también

SnmpSendMsg

SnmpSetRetransmitMode

Funciones winSNMP

Introducción a la API de WinSNMP