This topic has not yet been rated - Rate this topic

SnmpMgrCtl function

[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 SnmpMgrCtl function sets an operating parameter associated with an SNMP session. This function is an element of the SNMP Management API.

Syntax

C++


BOOL SnmpMgrCtl(
  _In_   LPSNMP_MGR_SESSION session,
  _In_   DWORD dwCtlCode,
  _In_   LPVOID lpvInBuffer,
  _In_   DWORD cbInBuffer,
  _Out_  LPVOID lpvOutBuffer,
  _Out_  DWORD cbOutBuffer,
  _Out_  LPDWORD lpcbBytesReturned
);

Parameters

session [in]

Pointer to an internal structure that specifies the session to which the control code applies.

dwCtlCode [in]

Specifies a value (a control code) that identifies the operation to perform.

Currently, MGMCTL_SETAGENTPORT is the only supported control code. Setting this code allows an SNMP management application to send requests to a remote agent that is "listening" for SNMP manager requests on an arbitrary port. For more information, see the lpvInBuffer and the cbInBuffer parameter descriptions.

lpvInBuffer [in]

Pointer to the buffer that contains the input parameters required for the operation.

When you specify the MGMCTL_SETAGENTPORT control code, this parameter must point to an unsigned integer that specifies the port number on which the remote agent will "listen" for SNMP manager requests. The port number must be in host-byte order.

cbInBuffer [in]

Specifies the size, in bytes, of the buffer pointed to by the lpvInBuffer parameter.

When you specify the MGMCTL_SETAGENTPORT control code, this parameter is equal to sizeof(UINT).

lpvOutBuffer [out]

Pointer to the buffer that receives the operation's output data.

cbOutBuffer [out]

Specifies the size, in bytes, of the buffer pointed to by the lpvOutBuffer parameter.

lpcbBytesReturned [out]

Pointer to a variable that receives the actual size, in bytes, of the data stored in the buffer pointed to by the lpvOutBuffer parameter.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError. GetLastError can also return one of the following error codes.

Return code	Description
SNMP_MGMTAPI_INVALID_CTL	The dwCtlCode parameter does not specify a valid control code.
SNMP_MGMTAPI_INVALID_SESSION	The session parameter does not specify a valid SNMP session.
SNMP_MGMTAPI_INVALID_BUFFER	One or more of the lpvInBuffer, lpvOutBuffer, or lpcbBytesRequired parameters are invalid, or the cbInBuffer or cbOutBuffer parameter is too small.

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Mgmtapi.h
Library	Mgmtapi.lib
DLL	Mgmtapi.dll

Community Additions