Função SnmpGetTimeout (winsnmp.h)
[O SNMP está disponível para uso nos sistemas operacionais especificados na seção Requisitos. Ele poderá ser alterado ou ficar indisponível em versões subsequentes. Em vez disso, use o Gerenciamento Remoto do Windows, que é a implementação da Microsoft do WS-Man.]
A função WinSNMP SnmpGetTimeout retorna o valor de tempo limite, em centésimos de segundo, para a transmissão de solicitações de mensagem SNMP. O valor de tempo limite se aplica a chamadas que um aplicativo WinSNMP faz para a função SnmpSendMsg para uma entidade de gerenciamento especificada.
Sintaxe
SNMPAPI_STATUS SNMPAPI_CALL SnmpGetTimeout(
[in] HSNMP_ENTITY hEntity,
[out] smiLPTIMETICKS nPolicyTimeout,
[out] smiLPTIMETICKS nActualTimeout
);
Parâmetros
[in] hEntity
Manipule para a entidade de gerenciamento de destino de interesse.
[out] nPolicyTimeout
Ponteiro para uma variável de inteiro para receber o valor de tempo limite, em centésimos de segundo, para a entidade de gerenciamento especificada. Esse é um valor que a implementação do Microsoft WinSNMP armazena em um banco de dados. Se você não precisar das informações retornadas nesse parâmetro, nPolicyRetry deverá ser um ponteiro NULL .
[out] nActualTimeout
Ponteiro para uma variável de inteiro para receber o último intervalo de resposta real ou estimado para a entidade de destino, conforme relatado pela implementação. Se você não precisar das informações retornadas nesse parâmetro, nActualRetry deverá ser um ponteiro NULL . Se esse parâmetro for um ponteiro válido, a função retornará 0. Para obter informações adicionais, consulte a seção Comentários a seguir.
Retornar valor
Se a função for bem-sucedida, o valor retornado será SNMPAPI_SUCCESS.
Se a função falhar, o valor retornado será SNMPAPI_FAILURE. Para obter informações de erro estendidas, chame SnmpGetLastError especificando um valor NULL em seu parâmetro de sessão . A função SnmpGetLastError pode retornar um dos erros a seguir.
| Código de retorno | Descrição |
|---|---|
|
A função SnmpStartup não foi concluída com êxito. |
|
Ocorreu um erro durante a alocação de memória. |
|
O parâmetro hEntity é inválido. |
|
Os parâmetros nPolicyRetry e nActualRetry são NULL. A operação não foi executada. |
|
Ocorreu um erro desconhecido ou indefinido. |
Comentários
Normalmente, um aplicativo WinSNMP, em vez de um aplicativo de agente, chama a função SnmpGetTimeout .
O período de tempo limite é o intervalo entre a chamada do aplicativo para a função SnmpSendMsg e sua chamada para a função SnmpRecvMsg .
Um aplicativo WinSNMP pode modificar o valor de tempo limite com uma chamada para a função SnmpSetTimeout .
O aplicativo WinSNMP pode monitorar o valor do parâmetro nActualRetry e compará-lo com o valor do parâmetro nPolicyRetry para otimizar o desempenho de transmissão. Para obter informações adicionais, consulte Sobre retransmissão e Gerenciamento da política de retransmissão.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows 2000 Professional [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows 2000 Server [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | winsnmp.h |
| Biblioteca | Wsnmp32.lib |
| DLL | Wsnmp32.dll |