Função SnmpMgrGetTrap (mgmtapi.h)

Artigo
02/29/2024

[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.]

A função SnmpMgrGetTrap retorna dados de interceptação pendentes que o chamador não recebeu se a recepção de interceptação estiver habilitada. Essa função é um elemento da API de Gerenciamento SNMP.

Além das informações retornadas por essa função, a função SnmpMgrGetTrapEx retorna o endereço da origem do transporte e a cadeia de caracteres da comunidade da interceptação.

Sintaxe

BOOL SNMP_FUNC_TYPE SnmpMgrGetTrap(
  [out] AsnObjectIdentifier *enterprise,
  [out] AsnNetworkAddress   *IPAddress,
  [out] AsnInteger          *genericTrap,
  [out] AsnInteger          *specificTrap,
  [out] AsnTimeticks        *timeStamp,
  [out] RFC1157VarBindList  *variableBindings
);

Parâmetros

[out] enterprise

Ponteiro para uma estrutura AsnObjectIdentifier para receber a empresa que gerou a interceptação SNMP.

[out] IPAddress

Ponteiro para uma variável para receber o endereço do agente que gerou a interceptação SNMP.

[out] genericTrap

Ponteiro para uma variável para receber um indicador da interceptação genérica. Esse parâmetro pode usar um dos valores a seguir.

Valor	Significado
SNMP_GENERICTRAP_COLDSTART	O agente está inicializando entidades de protocolo no modo gerenciado. Ele pode alterar objetos em sua exibição.
SNMP_GENERICTRAP_WARMSTART	O agente está se reinicializando, mas não alterará objetos em sua exibição.
SNMP_GENERICTRAP_LINKDOWN	Uma interface anexada foi alterada do estado "para cima" para o estado "inativo". A primeira variável na lista de associações de variáveis identifica a interface .
SNMP_GENERICTRAP_LINKUP	Uma interface anexada foi alterada do estado "para baixo" para o estado "para cima". A primeira variável na lista de associações de variáveis identifica a interface .
SNMP_GENERICTRAP_AUTHFAILURE	Uma entidade SNMP enviou uma mensagem SNMP, mas alegou falsamente pertencer a uma comunidade conhecida.
SNMP_GENERICTRAP_EGPNEIGHLOSS	Um par de EGP foi alterado para o estado "inativo". A primeira variável na lista de associações de variáveis identifica o endereço IP do par EGP.
SNMP_GENERICTRAP_ENTERSPECIFIC	Ocorreu um evento extraordinário e é identificado no parâmetro specificTrap com um valor específico da empresa.

[out] specificTrap

Ponteiro para uma variável para receber uma indicação da interceptação específica gerada.

[out] timeStamp

Ponteiro para uma variável para receber o carimbo de data/hora.

[out] variableBindings

Ponteiro para uma estrutura SnmpVarBindList para receber a lista de associações de variáveis.

Retornar valor

Se a função retornar uma interceptação, o valor retornado será TRUE. O código do erro pode ser recuperado chamando SnmpGetLastError imediatamente após a chamada.

Você deve chamar a função SnmpMgrGetTrap repetidamente até que ela retorne FALSE (zero). A função também pode retornar os seguintes códigos de erro.

Código de retorno	Descrição
SNMP_MGMTAPI_TRAP_ERRORS	Indica que erros foram encontrados; armadilhas não são acessíveis.
SNMP_MGMTAPI_NOTRAPS	Indica que não há armadilhas disponíveis.
SNMP_MEM_ALLOC_ERROR	Indica um erro de alocação de memória.

Comentários

O aplicativo sempre deve chamar a função SnmpMgrTrapListen antes de chamar a função SnmpMgrGetTrap . Isso ocorre porque o identificador de evento apontado pelo parâmetro phTrapAvailable da função SnmpMgrTrapListen permite a aquisição controlada por eventos de interceptações SNMP. A API de Gerenciamento de SNMP sinaliza o evento de um aplicativo quando o Serviço de Interceptação SNMP fornece uma interceptação.

O aplicativo também pode sondar a função SnmpMgrGetTrap para interceptações em intervalos regulares. Nesse caso, o aplicativo deve chamar SnmpMgrGetTrap repetidamente até que a função retorne zero.

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	mgmtapi.h
Biblioteca	Mgmtapi.lib
DLL	Mgmtapi.dll