Função SnmpCancelMsg (winsnmp.h)
[O SNMP está disponível para uso nos sistemas operacionais especificados na seção Requisitos. Ele poderá ser alterado ou ficar indisponível em versões subsequentes. Em vez disso, use o Gerenciamento Remoto do Windows, que é a implementação da Microsoft do WS-Man.]
Um aplicativo WinSNMP chama a função SnmpCancelMsg para solicitar que a implementação do Microsoft WinSNMP cancele tentativas de retransmissão e notificações de tempo limite para uma mensagem de solicitação SNMP. A função SnmpCancelMsg é um elemento da API WinSNMP, versão 2.0.
Sintaxe
SNMPAPI_STATUS SNMPAPI_CALL SnmpCancelMsg(
[in] HSNMP_SESSION session,
[in] smiINT32 reqId
);
Parâmetros
[in] session
Manipule para a sessão WinSNMP que enviou a PDU (mensagem de solicitação SNMP) a ser cancelada.
[in] reqId
Especifica um valor numérico exclusivo que identifica a PDU de interesse. Esse parâmetro deve corresponder ao identificador de solicitação (request_id) do parâmetro PDU especificado na chamada inicial do aplicativo para a função SnmpSendMsg .
Retornar valor
Se a função for bem-sucedida, o valor retornado será SNMPAPI_SUCCESS.
Se a função falhar, o valor retornado será SNMPAPI_FAILURE. Para obter informações de erro estendidas, chame SnmpGetLastError. A função SnmpGetLastError pode retornar um dos erros a seguir.
| Código de retorno | Descrição |
|---|---|
|
O parâmetro de sessão é inválido. |
|
O parâmetro reqId não identifica uma mensagem pendente para a sessão especificada. |
|
A função SnmpStartup não foi concluída com êxito. |
|
Ocorreu um erro durante a alocação de memória. |
|
Ocorreu um erro desconhecido ou indefinido. |
Comentários
Chamar a função SnmpCancelMsg é equivalente a chamar a função SnmpSetRetransmitMode para uma mensagem SNMP específica, com o modo de retransmissão igual a SNMPAPI_OFF.
Para obter mais informações, consulte Cancelando a retransmissão e Gerenciando a política de retransmissão.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows 2000 Professional [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows 2000 Server [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | winsnmp.h |
| Biblioteca | Wsnmp32.lib |
| DLL | Wsnmp32.dll |