Fonction SnmpGetTimeout (winsnmp.h)

[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. Au lieu de cela, utilisez La gestion à distance Windows, qui est l’implémentation Microsoft de WS-Man.]

La fonction SnmpGetTimeout WinSNMP retourne la valeur de délai d’attente, en centièmes de seconde, pour la transmission des demandes de message SNMP. La valeur de délai d’attente s’applique aux appels qu’une application WinSNMP effectue à la fonction SnmpSendMsg pour une entité de gestion spécifiée.

Syntaxe

SNMPAPI_STATUS SNMPAPI_CALL SnmpGetTimeout(
  [in]  HSNMP_ENTITY   hEntity,
  [out] smiLPTIMETICKS nPolicyTimeout,
  [out] smiLPTIMETICKS nActualTimeout
);

Paramètres

[in] hEntity

Gérez vers l’entité de gestion de destination qui vous intéresse.

[out] nPolicyTimeout

Pointeur vers une variable entière pour recevoir la valeur de délai d’attente, en centièmes de seconde, pour l’entité de gestion spécifiée. Il s’agit d’une valeur que l’implémentation Microsoft WinSNMP stocke dans une base de données. Si vous n’avez pas besoin des informations retournées dans ce paramètre, nPolicyRetry doit être un pointeur NULL .

[out] nActualTimeout

Pointeur vers une variable entière pour recevoir le dernier intervalle de réponse réel ou estimé pour l’entité de destination, comme indiqué par l’implémentation. Si vous n’avez pas besoin des informations retournées dans ce paramètre, nActualRetry doit être un pointeur NULL . Si ce paramètre est un pointeur valide, la fonction retourne 0. Pour plus d’informations, consultez la section Remarques suivante.

Valeur retournée

Si la fonction réussit, la valeur de retour est SNMPAPI_SUCCESS.

Si la fonction échoue, la valeur de retour est SNMPAPI_FAILURE. Pour obtenir des informations d’erreur étendues, appelez SnmpGetLastError en spécifiant une valeur NULL dans son paramètre de session . La fonction SnmpGetLastError peut retourner l’une des erreurs suivantes.

Code de retour	Description
SNMPAPI_NOT_INITIALIZED	La fonction SnmpStartup ne s’est pas terminée correctement.
SNMPAPI_ALLOC_ERROR	Une erreur s’est produite lors de l’allocation de mémoire.
SNMPAPI_ENTITY_INVALID	Le paramètre hEntity n’est pas valide.
SNMPAPI_NOOP	Les paramètres nPolicyRetry et nActualRetry sont tous deux NULL. L’opération n’a pas été effectuée.
SNMPAPI_OTHER_ERROR	Une erreur inconnue ou non définie s’est produite.

Remarques

En général, une application WinSNMP, plutôt qu’une application agent, appelle la fonction SnmpGetTimeout .

Le délai d’expiration est l’intervalle entre l’appel de l’application à la fonction SnmpSendMsg et son appel à la fonction SnmpRecvMsg .

Une application WinSNMP peut modifier la valeur du délai d’attente avec un appel à la fonction SnmpSetTimeout .

L’application WinSNMP peut surveiller la valeur du paramètre nActualRetry et la comparer à la valeur du paramètre nPolicyRetry pour optimiser les performances de transmission. Pour plus d’informations, consultez À propos de la retransmission et gestion de la stratégie de retransmission.

Configuration requise

Condition requise	Valeur
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	winsnmp.h
Bibliothèque	Wsnmp32.lib
DLL	Wsnmp32.dll

Voir aussi

SnmpGetRetransmitMode

SnmpSetRetransmitMode

SnmpSetTimeout

Fonctions WinSNMP

Vue d’ensemble de l’API WinSNMP