SnmpGetVb-Funktion (winsnmp.h)

Artikel
08/27/2023

[SNMP ist für die Verwendung in den Betriebssystemen verfügbar, die im Abschnitt "Anforderungen" angegeben sind. Es kann in nachfolgenden Versionen geändert oder entfernt werden. Verwenden Sie stattdessen die Windows-Remoteverwaltung, die Microsoft-Implementierung von WS-Man.]

Eine WinSNMP-Anwendung ruft die SnmpGetVb-Funktion auf, um Informationen aus einer Variablenbindungsliste abzurufen. Diese WinSNMP-Funktion ruft einen Variablennamen und den zugehörigen Wert aus dem Variablenbindungseintrag ab, der durch den Indexparameter angegeben wird.

Syntax

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

Parameter

[in] vbl

Behandeln Sie die abzurufende Variablenbindungsliste.

[in] index

Gibt eine Variable ohne Vorzeichen mit langer Ganzzahl an, die den abzurufenden Variablenbindungseintrag identifiziert. Diese Variable enthält die Position des Variablenbindungseintrags in der Liste der Variablenbindungen.

Gültige Werte für diesen Parameter liegen im Bereich von 1 bis n, wobei 1 den ersten Variablenbindungseintrag in der Liste der Variablenbindungen angibt, und n die Gesamtzahl der Einträge in der Liste. Weitere Informationen finden Sie im abschnitt "Hinweise".

[out] name

Zeiger auf eine smiOID-Struktur , um den Variablennamen des Variablenbindungseintrags zu erhalten.

[out] value

Zeiger auf eine smiVALUE-Struktur , um den Wert zu erhalten, der der Variablen zugeordnet ist, die durch den name-Parameter identifiziert wurde.

Wenn die Funktion erfolgreich ist, kann der Syntaxmember der Struktur, auf die der Wertparameter verweist, einer der folgenden Syntaxdatentypen sein. Weitere Informationen finden Sie unter RFC 1902, "Struktur der Verwaltungsinformationen für Version 2 des Simple Network Management Protocol (SNMPv2)."

Syntaxdatentyp	Bedeutung
SNMP_SYNTAX_INT	Gibt eine 32-Bit-Ganzzahlvariable mit Vorzeichen an.
SNMP_SYNTAX_OCTETS	Gibt eine Oktettzeichenfolgenvariable an, bei der es sich um binäre oder textuelle Daten handelt.
SNMP_SYNTAX_NULL	Gibt einen NULL-Wert an.
SNMP_SYNTAX_OID	Gibt eine Objektbezeichnervariable an, die ein zugewiesener Name mit maximal 128 Unteridentifizierern ist.
SNMP_SYNTAX_INT32	Gibt eine 32-Bit-Ganzzahlvariable mit Vorzeichen an.
SNMP_SYNTAX_IPADDR	Gibt eine 32-Bit-Internetadressenvariable an. Wenn das PDU-Trapformat SNMPv1 verwendet wird, um eine IPv6-Adresse darzustellen, ist dieser Wert 0.0.0.0.
SNMP_SYNTAX_CNTR32	Gibt eine Zählervariable an, die erhöht wird, bis sie einen Maximalwert von (2^32) – 1 erreicht.
SNMP_SYNTAX_GAUGE32	Gibt eine Messgerätvariable an, bei der es sich um eine nicht negative ganze Zahl handelt, die einen Maximalwert erhöhen oder verringern, aber nie überschreiten kann.
SNMP_SYNTAX_TIMETICKS	Gibt eine Zählervariable an, die die Zeit in hundertstel Sekunden misst, bis sie einen Maximalwert von (2^32) – 1 erreicht. Es handelt sich um eine nicht negative ganze Zahl, die relativ zu einem bestimmten Timerereignis ist.
SNMP_SYNTAX_OPAQUE	Dieser Typ bietet Abwärtskompatibilität und sollte nicht für neue Objekttypen verwendet werden. Es unterstützt die Funktion, beliebige ASN.1-Syntax (Abstract Syntax Notation 1) zu übergeben.
SNMP_SYNTAX_CNTR64	Gibt eine Zählervariable an, die erhöht wird, bis sie einen Maximalwert von (2^64) – 1 erreicht.
SNMP_SYNTAX_UINT32	Gibt eine 32-Bit-Ganzzahlvariable ohne Vorzeichen an.
SNMP_SYNTAX_NOSUCHOBJECT	Gibt an, dass der -Agent den Objekttyp, der der Variablen entspricht, nicht unterstützt.
SNMP_SYNTAX_NOSUCHINSTANCE	Gibt an, dass das Objekt instance für den Vorgang nicht vorhanden ist.
SNMP_SYNTAX_ENDOFMIBVIEW	Gibt an, dass die WinSNMP-Anwendung versucht, auf einen Objektbezeichner zu verweisen, der sich über das Ende der vom Agent unterstützten MIB-Struktur befindet.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert SNMPAPI_SUCCESS.

Wenn die Funktion fehlschlägt, wird der Rückgabewert SNMPAPI_FAILURE. Rufen Sie SnmpGetLastError auf, um erweiterte Fehlerinformationen zu erhalten. Die SnmpGetLastError-Funktion kann einen der folgenden Fehler zurückgeben.

Rückgabecode	Beschreibung
SNMPAPI_NOT_INITIALIZED	Die SnmpStartup-Funktion wurde nicht erfolgreich abgeschlossen.
SNMPAPI_ALLOC_ERROR	Während der Speicherzuordnung ist ein Fehler aufgetreten.
SNMPAPI_INDEX_INVALID	Der Indexparameter ist ungültig.
SNMPAPI_VBL_INVALID	Der vbl-Parameter ist ungültig.
SNMPAPI_OTHER_ERROR	Ein unbekannter oder nicht definierter Fehler ist aufgetreten.

Hinweise

Die letzten drei Syntaxtypen beschreiben Ausnahmebedingungen unter dem FRAMEWORK SNMP Version 2C (SNMPv2C).

Die SnmpGetVb-Funktion gibt den Variablennamen des Variablenbindungseintrags in der Struktur zurück, auf die der name-Parameter verweist. Es gibt den zugeordneten Wert der Variablen in der Struktur zurück, auf die der Wertparameter verweist.

Bei der Eingabe ignoriert die SnmpGetVb-Funktion die Member der Strukturen smiOID und smiVALUE , auf die durch den Parametername bzw. Wert verwiesen wird. Die Microsoft WinSNMP-Implementierung überschreibt die Member, wenn die Funktion erfolgreich abgeschlossen wird.

Gültige Werte für eine WinSNMP-Anwendung, die für den Indexparameter verwendet werden soll, lauten wie folgt:

Der Rückgabewert eines Aufrufs der SnmpCountVbl-Funktion
Das Fehlerindexfeld einer SNMP_PDU_RESPONSE Protokolldateneinheit (PDU), die von einem Aufruf der SnmpRecvMsg-Funktion zurückgegeben wird

Die WinSNMP-Anwendung muss die SnmpFreeDescriptor-Funktion aufrufen, um Ressourcen freizugeben, die für das ptr-Element der smiOID-Struktur zugewiesen sind, auf die der name-Parameter verweist. Die Anwendung muss auch die SnmpFreeDescriptor-Funktion aufrufen, um Ressourcen freizugeben, die für die smiVALUE-Struktur zugewiesen sind, auf die der value-Parameter unter den folgenden Bedingungen verweist. Wenn es sich bei dem Wertmember um eine smiOCTETS- oder smiOID-Struktur handelt, muss die Anwendung SnmpFreeDescriptor aufrufen, um die für diese Strukturen zugewiesenen Ressourcen freizugeben. Weitere Informationen finden Sie unter WinSNMP Datenverwaltung Concepts.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winsnmp.h
Bibliothek	Wsnmp32.lib
DLL	Wsnmp32.dll