SnmpMgrOpen function (mgmtapi.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 SnmpMgrOpen function initializes communications sockets and data structures, allowing communications with the specified SNMP agent. This function is an element of the SNMP Management API.

Syntax

LPSNMP_MGR_SESSION SNMP_FUNC_TYPE SnmpMgrOpen(
  [in] LPSTR lpAgentAddress,
  [in] LPSTR lpAgentCommunity,
  [in] INT   nTimeOut,
  [in] INT   nRetries
);

Parameters

[in] lpAgentAddress

Pointer to a null-terminated string that specifies a host name or an IP address. The host name must resolve to an IP address, an IPX address (in 8.12 notation), or an ethernet address. See the Remarks section for the acceptable forms for host names and IP addresses.

[in] lpAgentCommunity

Pointer to a null-terminated string that specifies the SNMP community name to use when communicating with the agent that is identified by the lpAgentAddress parameter.

[in] nTimeOut

Specifies the communications time-out in milliseconds.

[in] nRetries

Specifies the communications retry count. The time-out that is specified in the nTimeOut parameter is doubled each time that a retry attempt is transmitted.

Return value

If the function succeeds, the return value is a pointer to an LPSNMP_MGR_SESSION structure. This structure is used internally and the programmer should not alter it. For more information, see the following Remarks section.

If the function fails, the return value is NULL. To get extended error information, call GetLastError. GetLastError may return the SNMP_MEM_ALLOC_ERROR error code, which indicates a memory allocation error.

This function may also return Windows Sockets error codes.

Remarks

If possible, use a host name to identify the SNMP agent in the lpAgentAddress parameter. Host names can be provided for agents only if TCP/IP is loaded and the names are TCP/IP host names. NetBIOS names cannot be supplied for IPX hosts.

The name and address of the SNMP target, or the string pointed to by the lpAgentAddress parameter, should conform to one of the following forms.

Applications should not use the LPSNMP_MGR_SESSION pointer that is returned by this function to call the SnmpMgrRequest function in the context of a different thread.

Requirements

See also

SNMP Functions

Simple Network Management Protocol (SNMP) Overview

SnmpMgrClose

SnmpMgrRequest