SnmpStartupEx function (winsnmp.h)

[SNMP is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Instead, use Windows Remote Management, which is the Microsoft implementation of WS-Man.]

The SnmpStartupEx function notifies the Microsoft WinSNMP implementation that the WinSNMP application requires the implementation's services. The WinSNMP SnmpStartupEx function enables the implementation to initialize and to return to the application the version of the Windows SNMP Application Programming Interface (WinSNMP API), the level of SNMP communications that the implementation supports, and the implementation's default translation and retransmission modes.

This function should be used instead of SnmpStartup if Windows Server 2003 with Service Pack 1 (SP1) or later is installed. SnmpStartupEx enables support for multiple independent software modules that use WinSNMP within the same application.

Syntax

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

Parameters

[out] nMajorVersion

Pointer to an unsigned long integer variable to receive the major version number of the WinSNMP API that the implementation supports. For example, to indicate that the implementation supports WinSNMP version 2.0, the function returns a value of 2.

[out] nMinorVersion

Pointer to an unsigned long integer variable to receive the minor version number of the WinSNMP API that the implementation supports. For example, to indicate that the implementation supports WinSNMP version 2.0, the function returns a value of 0.

[out] nLevel

Pointer to an unsigned long integer variable to receive the highest level of SNMP communications the implementation supports. Upon successful return, this parameter contains a value of 2. For a description of level 2 support, see Levels of SNMP Support.

[out] nTranslateMode

Pointer to an unsigned long integer variable to receive the default translation mode in effect for the implementation. The translation mode applies to how the implementation interprets the entity parameter, that the WinSNMP application passes to the SnmpStrToEntity function. The translation mode also applies to the string parameter that the WinSNMP application passes to the SnmpStrToContext function. This parameter can be one of the following values.

For additional information, see Setting the Entity and Context Translation Mode.

[out] nRetransmitMode

Pointer to an unsigned long integer variable to receive the default retransmission mode in effect for the implementation. This parameter can be one of the following values.

For additional information, see About Retransmission.

Return value

If the function succeeds, the return value is SNMPAPI_SUCCESS, and the parameters contain appropriate values, as indicated in the preceding parameter descriptions.

If the function fails, the return value is SNMPAPI_FAILURE. To get extended error information, call SnmpGetLastError specifying a NULL value in its session parameter. The SnmpGetLastError function can return one of the following errors. For additional information, see the "Remarks" section later in this document.

Remarks

A WinSNMP application must call the SnmpStartupEx function successfully at least once, before it calls any other WinSNMP function. If a WinSNMP application calls another WinSNMP function before it successfully calls SnmpStartupEx, the implementation returns the error SNMPAPI_NOT_INITIALIZED.

The WinSNMP application can call SnmpGetLastError for error information, or retry SnmpStartupEx if a call to the SnmpStartupEx function fails. When SnmpStartupEx returns SNMPAPI_FAILURE, and a subsequent call to SnmpGetLastError returns SNMP_ALLOC_ERROR, the WinSNMP application can elect to wait. It can retry the call to SnmpStartupEx when the implementation has adequate free resources.

A WinSNMP application must call SnmpCleanupEx for each successful call to SnmpStartupEx. The WinSNMP implementation performs the final cleanup where there are no outstanding successful calls to SnmpStartup or SnmpStartupEx.

For additional information, see Levels of SNMP Support and About SNMP Versions.

Requirements

See also

SnmpCleanupEx

SnmpStrToContext

SnmpStrToEntity

WinSNMP API Overview

WinSNMP Functions