Funzione SnmpGetVb (winsnmp.h)

Articolo
08/27/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.

Un'applicazione WinSNMP chiama la funzione SnmpGetVb per recuperare informazioni da un elenco di associazioni di variabili. Questa funzione WinSNMP recupera un nome di variabile e il relativo valore associato dalla voce di associazione di variabili specificata dal parametro indice .

Sintassi

SNMPAPI_STATUS SNMPAPI_CALL SnmpGetVb(
  [in]  HSNMP_VBL  vbl,
  [in]  smiUINT32  index,
  [out] smiLPOID   name,
  [out] smiLPVALUE value
);

Parametri

[in] vbl

Gestire l'elenco di associazioni di variabili da recuperare.

[in] index

Specifica una variabile integer long senza segno che identifica la voce di associazione di variabili da recuperare. Questa variabile contiene la posizione della voce di associazione di variabili, all'interno dell'elenco di associazioni di variabili.

I valori validi per questo parametro si trovano nell'intervallo compreso tra 1 e n, dove 1 indica la prima voce di associazione di variabili nell'elenco associazioni di variabili e n è il numero totale di voci nell'elenco. Per altre informazioni, vedere la sezione Osservazioni seguenti.

[out] name

Puntatore a una struttura smiOID per ricevere il nome della variabile della voce di associazione di variabili.

[out] value

Puntatore a una struttura smiVALUE per ricevere il valore associato alla variabile identificata dal parametro name .

Se la funzione ha esito positivo, il membro della sintassi della struttura puntato dal parametro value può essere uno dei tipi di dati della sintassi seguenti. Per altre informazioni, vedere RFC 1902, "Struttura delle informazioni di gestione per la versione 2 del protocollo di gestione di rete semplice (SNMPv2)."

Tipo di dati della sintassi	Significato
SNMP_SYNTAX_INT	Indica una variabile integer con segno a 32 bit.
SNMP_SYNTAX_OCTETS	Indica una variabile di stringa ottet che è dati binari o testuali.
SNMP_SYNTAX_NULL	Indica un valore NULL .
SNMP_SYNTAX_OID	Indica una variabile di identificatore di oggetto che è un nome assegnato con un massimo di 128 sottoidentifier.
SNMP_SYNTAX_INT32	Indica una variabile integer con segno a 32 bit.
SNMP_SYNTAX_IPADDR	Indica una variabile di indirizzo Internet a 32 bit. Se il formato trap SNMPv1 PDU viene usato per rappresentare un indirizzo IPv6, questo valore è 0.0.0.0.
SNMP_SYNTAX_CNTR32	Indica una variabile contatore che aumenta fino a raggiungere un valore massimo di (2^32) - 1.
SNMP_SYNTAX_GAUGE32	Indica una variabile del misuratore che è un intero non negativo che può aumentare o diminuire, ma non superare mai un valore massimo.
SNMP_SYNTAX_TIMETICKS	Indica una variabile contatore che misura il tempo in centesimi di secondo, fino a raggiungere un valore massimo pari a (2^32) - 1. È un intero non negativo relativo a un evento timer specifico.
SNMP_SYNTAX_OPAQUE	Questo tipo fornisce compatibilità con le versioni precedenti e non deve essere usato per i nuovi tipi di oggetto. Supporta la funzionalità per passare la sintassi astratta arbitraria Notation One (ASN.1).
SNMP_SYNTAX_CNTR64	Indica una variabile di contatore che aumenta fino a raggiungere un valore massimo di (2^64) - 1.
SNMP_SYNTAX_UINT32	Indica una variabile integer senza segno a 32 bit.
SNMP_SYNTAX_NOSUCHOBJECT	Indica che l'agente non supporta il tipo di oggetto corrispondente alla variabile.
SNMP_SYNTAX_NOSUCHINSTANCE	Indica che l'istanza dell'oggetto non esiste per l'operazione.
SNMP_SYNTAX_ENDOFMIBVIEW	Indica che l'applicazione WinSNMP sta tentando di fare riferimento a un identificatore di oggetto che supera la fine dell'albero MIB supportato dall'agente.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è SNMPAPI_SUCCESS.

Se la funzione ha esito negativo, il valore restituito è SNMPAPI_FAILURE. Per ottenere informazioni sull'errore estese, chiamare SnmpGetLastError. La funzione SnmpGetLastError può restituire uno degli errori seguenti.

Codice restituito	Descrizione
SNMPAPI_NOT_INITIALIZED	La funzione SnmpStartup non è stata completata correttamente.
SNMPAPI_ALLOC_ERROR	Errore durante l'allocazione della memoria.
SNMPAPI_INDEX_INVALID	Il parametro di indice non è valido.
SNMPAPI_VBL_INVALID	Il parametro vbl non è valido.
SNMPAPI_OTHER_ERROR	Si è verificato un errore sconosciuto o non definito.

Commenti

Gli ultimi tre tipi di sintassi descrivono le condizioni di eccezione nel framework SNMP versione 2C(SNMPv2C).

La funzione SnmpGetVb restituisce il nome della variabile della voce di associazione di variabili nella struttura a cui fa riferimento il parametro name . Restituisce il valore associato della variabile nella struttura a cui punta il parametro value .

In input, la funzione SnmpGetVb ignora rispettivamente i membri delle strutture smiOID e smiVALUE a cui puntano i parametri nome e valore. L'implementazione di Microsoft WinSNMP sovrascrive i membri se la funzione viene completata correttamente.

I valori validi per un'applicazione WinSNMP da usare per il parametro di indice sono i seguenti:

Valore restituito da una chiamata alla funzione SnmpCountVbl
Campo dell'indice di errore di un'unità dati del protocollo di SNMP_PDU_RESPONSE restituita da una chiamata alla funzione SnmpRecvMsg

L'applicazione WinSNMP deve chiamare la funzione SnmpFreeDescriptor per liberare risorse allocate per il membro ptr della struttura smiOID a cui punta il parametro del nome . L'applicazione deve anche chiamare la funzione SnmpFreeDescriptor per rilasciare le risorse allocate per la struttura smiVALUE a cui fa riferimento il parametro valore in base alle condizioni seguenti. Se il membro del valore è un smiOCTETS o una struttura smiOID , l'applicazione deve chiamare SnmpFreeDescriptor per liberare le risorse allocate per queste strutture. Per altre informazioni, vedere Concetti di Gestione dati WinSNMP.

Requisiti


Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	winsnmp.h
Libreria	Wsnmp32.lib
DLL	Wsnmp32.dll