Funzione SnmpMgrGetTrapEx (mgmtapi.h)

Articolo
08/24/2023

[SNMP è disponibile per l'uso nei sistemi operativi specificati nella sezione Requisiti. È possibile che in versioni successive sia stata modificata o non sia più disponibile. Usare invece Gestione remota Windows, ovvero l'implementazione Microsoft di WS-Man.

La funzione SnmpMgrGetTrapEx restituisce dati di trap in sospeso che il chiamante non ha ricevuto se la ricezione trap è abilitata. Oltre alle informazioni restituite dalla funzione SnmpMgrGetTrap , questa funzione estesa restituisce l'indirizzo dell'origine del trasporto e la stringa della community della trap. Questa funzione è un elemento dell'API di gestione SNMP.

Sintassi

BOOL SNMP_FUNC_TYPE SnmpMgrGetTrapEx(
  [out] AsnObjectIdentifier *enterprise,
  [out] AsnNetworkAddress   *agentAddress,
  [out] AsnNetworkAddress   *sourceAddress,
  [out] AsnInteger          *genericTrap,
  [out] AsnInteger          *specificTrap,
  [out] AsnOctetString      *community,
  [out] AsnTimeticks        *timeStamp,
  [out] RFC1157VarBindList  *variableBindings
);

Parametri

[out] enterprise

Puntatore a una struttura AsnObjectIdentifier per ricevere l'organizzazione che ha generato la trap SNMP.

[out] agentAddress

Puntatore a una variabile per ricevere l'indirizzo dell'agente che ha generato la trap SNMP; queste informazioni vengono recuperate dall'unità dati del protocollo SNMP (PDU).

[out] sourceAddress

Puntatore a una variabile per ricevere l'indirizzo dell'agente che ha generato la trap SNMP; queste informazioni vengono recuperate dal trasporto di rete.

[out] genericTrap

Puntatore a una variabile per ricevere un indicatore della trappola generica. Questo parametro può avere uno dei valori seguenti.

Valore	Significato
SNMP_GENERICTRAP_COLDSTART	L'agente inizializza le entità del protocollo nella modalità gestita. Può modificare gli oggetti nella relativa visualizzazione.
SNMP_GENERICTRAP_WARMSTART	L'agente sta reinizializzando se stesso, ma non altererà gli oggetti nella relativa visualizzazione.
SNMP_GENERICTRAP_LINKDOWN	Un'interfaccia associata è stata modificata dallo stato in alto allo stato inattivo. La prima variabile nell'elenco associazioni di variabili identifica l'interfaccia.
SNMP_GENERICTRAP_LINKUP	Un'interfaccia associata è stata modificata dallo stato inferiore allo stato su. La prima variabile nell'elenco associazioni di variabili identifica l'interfaccia.
SNMP_GENERICTRAP_AUTHFAILURE	Un'entità SNMP ha inviato un messaggio SNMP, ma ha falsemente affermato di appartenere a una community nota.
SNMP_GENERICTRAP_EGPNEIGHLOSS	Un peer EGP è stato modificato nello stato inattivo. La prima variabile nell'elenco associazioni di variabili identifica l'indirizzo IP del peer EGP.
SNMP_GENERICTRAP_ENTERSPECIFIC	Si è verificato un evento straordinario. Viene identificato nel parametro specificoTrap con un valore specifico dell'organizzazione.

[out] specificTrap

Puntatore a una variabile per ricevere un indicatore della trappola specifica generata.

[out] community

Puntatore a una struttura AsnOctetString per ricevere la stringa della community della trap SNMP generata.

[out] timeStamp

Puntatore a una variabile per ricevere il timestamp.

[out] variableBindings

Puntatore a una struttura SnmpVarBindList per ricevere l'elenco di associazioni di variabili.

Valore restituito

Se la funzione restituisce una trap, il valore restituito è diverso da zero.

È necessario chiamare ripetutamente la funzione SnmpMgrGetTrapEx fino a quando non restituisce zero. La funzione può anche restituire i codici di errore seguenti.

Codice restituito	Descrizione
SNMP_MGMTAPI_TRAP_ERRORS	Indica che sono stati rilevati errori; le trap non sono accessibili.
SNMP_MGMTAPI_NOTRAPS	Indica che non sono disponibili trap.
SNMP_MEM_ALLOC_ERROR	Indica un errore di allocazione della memoria.

Commenti

L'applicazione deve sempre chiamare la funzione SnmpMgrTrapListen prima di chiamare la funzione SnmpMgrGetTrapEx . Ciò avviene perché l'handle eventi a cui fa riferimento il parametro phTrapAvailable della funzione SnmpMgrTrapListen consente l'acquisizione basata su eventi di trap SNMP. L'API di gestione SNMP segnala un evento dell'applicazione quando il servizio trap SNMP genera una trappola.

L'applicazione può anche eseguire il polling della funzione SnmpMgrGetTrapEx per le trap a intervalli regolari. In questo caso, l'applicazione deve chiamare ripetutamente SnmpMgrGetTrapEx fino a quando la funzione restituisce zero.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	mgmtapi.h
Libreria	Mgmtapi.lib
DLL	Mgmtapi.dll