Función SnmpMgrCtl (mgmtapi.h)

[SNMP está disponible para su uso en los sistemas operativos especificados en la sección Requisitos. En versiones posteriores podría modificarse o no estar disponible. En su lugar, use la administración remota de Windows, que es la implementación de Microsoft de WS-Man.]

La función SnmpMgrCtl establece un parámetro operativo asociado a una sesión snmp. Esta función es un elemento de la API de administración de SNMP.

Sintaxis

BOOL SNMP_FUNC_TYPE SnmpMgrCtl(
  [in]  LPSNMP_MGR_SESSION session,
  [in]  DWORD              dwCtlCode,
  [in]  LPVOID             lpvInBuffer,
  [in]  DWORD              cbInBuffer,
  [out] LPVOID             lpvOUTBuffer,
  [out] DWORD              cbOUTBuffer,
  [out] LPDWORD            lpcbBytesReturned
);

Parámetros

[in] session

Puntero a una estructura interna que especifica la sesión a la que se aplica el código de control.

[in] dwCtlCode

Especifica un valor (un código de control) que identifica la operación que se va a realizar.

Actualmente, MGMCTL_SETAGENTPORT es el único código de control admitido. Establecer este código permite que una aplicación de administración snmp envíe solicitudes a un agente remoto que esté "escuchando" las solicitudes del administrador SNMP en un puerto arbitrario. Para obtener más información, consulte las descripciones de parámetros lpvInBuffer y cbInBuffer .

[in] lpvInBuffer

Puntero al búfer que contiene los parámetros de entrada necesarios para la operación.

Al especificar el código de control de MGMCTL_SETAGENTPORT, este parámetro debe apuntar a un entero sin signo que especifique el número de puerto en el que el agente remoto "escuchará" las solicitudes del administrador snmp. El número de puerto debe estar en orden de bytes de host.

[in] cbInBuffer

Especifica el tamaño, en bytes, del búfer al que apunta el parámetro lpvInBuffer .

Al especificar el código de control de MGMCTL_SETAGENTPORT, este parámetro es igual a sizeof(UINT).

[out] lpvOUTBuffer

Puntero al búfer que recibe los datos de salida de la operación.

[out] cbOUTBuffer

Especifica el tamaño, en bytes, del búfer al que apunta el parámetro lpvOutBuffer .

[out] lpcbBytesReturned

Puntero a una variable que recibe el tamaño real, en bytes, de los datos almacenados en el búfer al que apunta el parámetro lpvOutBuffer .

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError. GetLastError también puede devolver uno de los siguientes códigos de error.

Código devuelto	Descripción
SNMP_MGMTAPI_INVALID_CTL	El parámetro dwCtlCode no especifica un código de control válido.
SNMP_MGMTAPI_INVALID_SESSION	El parámetro session no especifica una sesión SNMP válida.
SNMP_MGMTAPI_INVALID_BUFFER	Uno o varios de los parámetros lpvInBuffer, lpvOutBuffer o lpcbBytesRequired no son válidos o el parámetro cbInBuffer o cbOutBuffer es demasiado pequeño.

Requisitos

Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	mgmtapi.h
Library	Mgmtapi.lib
Archivo DLL	Mgmtapi.dll

Consulte también

Funciones SNMP

Introducción al Protocolo simple de administración de redes (SNMP)

SnmpMgrOpen