SnmpStartup-Funktion (winsnmp.h)

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

Die SnmpStartup-Funktion benachrichtigt die Microsoft WinSNMP-Implementierung, dass die WinSNMP-Anwendung die Dienste der Implementierung erfordert. Die WinSNMP SnmpStartup-Funktion ermöglicht es der Implementierung, die Version der Windows SNMP-Anwendungsprogrammierschnittstelle (WinSNMP-API), die von der Implementierung unterstützte SNMP-Kommunikationsebene und die Standardübersetzungs- und Neuübertragungsmodi der Implementierung zu initialisieren und an die Anwendung zurückzugeben.

Hinweis Eine WinSNMP-Anwendung muss die SnmpStartup-Funktion erfolgreich aufrufen, bevor sie eine andere WinSNMP-Funktion aufruft.
 

Syntax

SNMPAPI_STATUS SNMPAPI_CALL SnmpStartup(
  [out] smiLPUINT32 nMajorVersion,
  [out] smiLPUINT32 nMinorVersion,
  [out] smiLPUINT32 nLevel,
  [out] smiLPUINT32 nTranslateMode,
  [out] smiLPUINT32 nRetransmitMode
);

Parameter

[out] nMajorVersion

Zeiger auf eine variable ohne Vorzeichen mit langer Ganzzahl, um die Hauptversionsnummer der WinSNMP-API zu erhalten, die von der Implementierung unterstützt wird. Um beispielsweise anzugeben, dass die Implementierung WinSNMP Version 2.0 unterstützt, gibt die Funktion den Wert 2 zurück.

[out] nMinorVersion

Zeiger auf eine variable ohne Vorzeichen mit langer Ganzzahl, um die Nebenversionsnummer der WinSNMP-API zu erhalten, die von der Implementierung unterstützt wird. Um beispielsweise anzugeben, dass die Implementierung WinSNMP Version 2.0 unterstützt, gibt die Funktion den Wert 0 zurück.

[out] nLevel

Zeiger auf eine ganzzahlige Variable ohne Vorzeichen, um die höchste SNMP-Kommunikationsebene zu empfangen, die von der Implementierung unterstützt wird. Nach erfolgreicher Rückgabe enthält dieser Parameter den Wert 2. Eine Beschreibung der Unterstützung der Stufe 2 finden Sie unter Stufen der SNMP-Unterstützung.

[out] nTranslateMode

Zeiger auf eine ganzzahlige Variable ohne Vorzeichen, um den für die Implementierung gültigen Standardübersetzungsmodus zu empfangen. Der Übersetzungsmodus gilt für die Interpretation des Entitätsparameters durch die Implementierung, den die WinSNMP-Anwendung an die SnmpStrToEntity-Funktion übergibt. Der Übersetzungsmodus gilt auch für den Zeichenfolgenparameter , den die WinSNMP-Anwendung an die SnmpStrToContext-Funktion übergibt. Dieser Parameter kann einen der folgenden Werte annehmen.

Wert Bedeutung
SNMPAPI_TRANSLATED
Die Implementierung verwendet ihre Datenbank, um benutzerfreundliche Namen für SNMP-Entitäten und verwaltete Objekte zu übersetzen. Die Implementierung übersetzt sie in ihre SNMPv1- oder SNMPv2C-Komponenten.
SNMPAPI_UNTRANSLATED_V1
Die Implementierung interpretiert SNMP-Entitätsparameter als SNMP-Transportadressen und Kontextparameter als SNMP-Communityzeichenfolgen. Für SNMPv2-Zielentitäten erstellt die Implementierung ausgehende SNMP-Nachrichten, die den Wert null im Versionsfeld enthalten.
SNMPAPI_UNTRANSLATED_V2
Die Implementierung interpretiert SNMP-Entitätsparameter als SNMP-Transportadressen und Kontextparameter als SNMP-Communityzeichenfolgen. Für SNMPv2-Zielentitäten erstellt die Implementierung ausgehende SNMP-Nachrichten, die den Wert 1 im Versionsfeld enthalten.
 

Weitere Informationen finden Sie unter Festlegen des Entitäts- und Kontextübersetzungsmodus.

[out] nRetransmitMode

Zeiger auf eine variable ohne Vorzeichen mit langer Ganzzahl, um den für die Implementierung gültigen Standard-Wiederübertragungsmodus zu empfangen. Dieser Parameter kann einen der folgenden Werte annehmen.

Wert Bedeutung
SNMPAPI_OFF
Die Implementierung führt die Erneuteübertragungsrichtlinie der WinSNMP-Anwendung nicht aus.
SNMPAPI_ON
Die Implementierung führt die Erneuteübertragungsrichtlinie der WinSNMP-Anwendung aus.
 

Weitere Informationen finden Sie unter Informationen zur erneuten Übertragung.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert SNMPAPI_SUCCESS, und die Parameter enthalten entsprechende Werte, wie in den vorherigen Parameterbeschreibungen angegeben.

Wenn die Funktion fehlschlägt, wird der Rückgabewert SNMPAPI_FAILURE. Um erweiterte Fehlerinformationen abzurufen, rufen Sie SnmpGetLastError auf, indem Sie einen NULL-Wert im Sitzungsparameter angeben. Die SnmpGetLastError-Funktion kann einen der folgenden Fehler zurückgeben. Weitere Informationen finden Sie im folgenden Abschnitt Hinweise.

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_OTHER_ERROR
Ein unbekannter oder nicht definierter Fehler ist aufgetreten.

Hinweise

Eine WinSNMP-Anwendung muss die SnmpStartup-Funktion mindestens einmal erfolgreich aufrufen, bevor sie eine andere WinSNMP-Funktion aufruft. Wenn eine WinSNMP-Anwendung eine andere WinSNMP-Funktion aufruft, bevor snmpStartup erfolgreich aufgerufen wird, gibt die Implementierung den Fehler SNMPAPI_NOT_INITIALIZED zurück.

Die WinSNMP-Anwendung kann SnmpGetLastError für Fehlerinformationen aufrufen oder SnmpStartup wiederholen, wenn ein Aufruf der SnmpStartup-Funktion fehlschlägt. Wenn SnmpStartup SNMPAPI_FAILURE zurückgibt und ein späterer Aufruf von SnmpGetLastError SNMP_ALLOC_ERROR zurückgibt, kann die WinSNMP-Anwendung warten. Es kann den Aufruf von SnmpStartup wiederholen, wenn die Implementierung über ausreichende freie Ressourcen verfügt.

Eine WinSNMP-Anwendung kann SnmpStartup mehrmals aufrufen. Beispielsweise muss der Funktionsaufruf aus den zuvor erläuterten Gründen erneut ausgeführt werden. Eine WinSNMP-Anwendung muss auch SnmpCleanup mindestens einmal aufrufen, da der letzte WinSNMP-Funktionsaufruf vor dem Beenden erfolgt. Mehrere SnmpStartup-Aufrufe erfordern nicht mehrere SnmpCleanup-Aufrufe .

Weitere Informationen finden Sie unter Stufen der SNMP-Unterstützung und Informationen zu SNMP-Versionen.

Anforderungen

Anforderung Wert
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

Weitere Informationen

SnmpCleanup

SnmpStrToContext

SnmpStrToEntity

WinSNMP-Funktionen

Übersicht über die WinSNMP-API