SnmpMgrCtl, fonction (mgmtapi.h)

Article
08/24/2023

[SNMP est disponible pour une utilisation dans les systèmes d’exploitation spécifiés dans la section Configuration requise. Il sera peut-être modifié ou indisponible dans les versions ultérieures. Utilisez plutôt Windows Remote Management, qui est l’implémentation Microsoft de WS-Man.]

La fonction SnmpMgrCtl définit un paramètre d’exploitation associé à une session SNMP. Cette fonction est un élément de l’API de gestion SNMP.

Syntaxe

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
);

Paramètres

[in] session

Pointeur vers une structure interne qui spécifie la session à laquelle le code de contrôle s’applique.

[in] dwCtlCode

Spécifie une valeur (un code de contrôle) qui identifie l’opération à effectuer.

Actuellement, MGMCTL_SETAGENTPORT est le seul code de contrôle pris en charge. La définition de ce code permet à une application de gestion SNMP d’envoyer des requêtes à un agent distant qui « écoute » les demandes du gestionnaire SNMP sur un port arbitraire. Pour plus d’informations, consultez la description des paramètres lpvInBuffer et cbInBuffer .

[in] lpvInBuffer

Pointeur vers la mémoire tampon qui contient les paramètres d’entrée requis pour l’opération.

Lorsque vous spécifiez le code de contrôle MGMCTL_SETAGENTPORT, ce paramètre doit pointer vers un entier non signé qui spécifie le numéro de port sur lequel l’agent distant « écoute » les demandes du gestionnaire SNMP. Le numéro de port doit être dans l’ordre d’octet de l’hôte.

[in] cbInBuffer

Spécifie la taille, en octets, de la mémoire tampon vers laquelle pointe le paramètre lpvInBuffer .

Lorsque vous spécifiez le code de contrôle MGMCTL_SETAGENTPORT, ce paramètre est égal à sizeof(UINT).

[out] lpvOUTBuffer

Pointeur vers la mémoire tampon qui reçoit les données de sortie de l’opération.

[out] cbOUTBuffer

Spécifie la taille, en octets, de la mémoire tampon pointée vers le paramètre lpvOutBuffer .

[out] lpcbBytesReturned

Pointeur vers une variable qui reçoit la taille réelle, en octets, des données stockées dans la mémoire tampon vers laquelle pointe le paramètre lpvOutBuffer .

Valeur retournée

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError. GetLastError peut également retourner l’un des codes d’erreur suivants.

Code de retour	Description
SNMP_MGMTAPI_INVALID_CTL	Le paramètre dwCtlCode ne spécifie pas de code de contrôle valide.
SNMP_MGMTAPI_INVALID_SESSION	Le paramètre de session ne spécifie pas de session SNMP valide.
SNMP_MGMTAPI_INVALID_BUFFER	Un ou plusieurs des paramètres lpvInBuffer, lpvOutBuffer ou lpcbBytesRequired ne sont pas valides, ou le paramètre cbInBuffer ou cbOutBuffer est trop petit.

Spécifications


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	mgmtapi.h
Bibliothèque	Mgmtapi.lib
DLL	Mgmtapi.dll

Voir aussi

Fonctions SNMP

Vue d’ensemble du protocole SNMP (Simple Network Management Protocol)

SnmpMgrOpen

Partager via