SnmpMgrOpen
The SnmpMgrOpen
function initializes communications sockets and data structures, allowing
communications with the specified agent.
LPSNMP_MGR_SESSION SnmpMgrOpen(
|
LPSTR lpAgentAddress, |
// name and
address of target SNMP agent |
|
LPSTR lpAgentCommunity, |
// community
for target SNMP agent |
|
INT nTimeOut, |
//
communication time-out in milliseconds |
|
INT nRetries |
//
communication time-out or retry count |
|
); |
|
Parameters
lpAgentAddress
[in] Points
to a null-terminated string specifying either a dotted-decimal IP address or a
host name that can be resolved to an IP address, an IPX address (in 8.12
notation), or an ethernet address.
lpAgentCommunity
[in] Points
to a null-terminated string specifying the SNMP community name used when
communicating with the agent specified in the lpAgentAddress parameter.
nTimeOut
[in]
Specifies the communications time-out in milliseconds.
nRetries
[in]
Specifies the communications retry count. The time-out specified in the nTimeOut
parameter is doubled each time a retry attempt is transmitted.
Return Values
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.
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.
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:
|
Name/Address |
Form
(example) |
|
IP Address |
157.57.8.160 |
|
IP Hostname |
merlin.microsoft.com |
|
Ethernet
Address |
00aa00bbccdd |
|
IPX Address |
00006112.00aa00bbccdd |
Remarks
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.
See Also
SnmpMgrClose, SnmpMgrRequest