Função SnmpGetRetry (winsnmp.h)

Artigo
08/27/2023

[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 SnmpGetRetry retorna o valor de contagem de repetições, em unidades, para a retransmissão de solicitações de mensagem SNMP. A contagem de repetições se aplica a chamadas que um aplicativo WinSNMP faz à função SnmpSendMsg para uma entidade de gerenciamento especificada.

Sintaxe

SNMPAPI_STATUS SNMPAPI_CALL SnmpGetRetry(
  [in]  HSNMP_ENTITY hEntity,
  [out] smiLPUINT32  nPolicyRetry,
  [out] smiLPUINT32  nActualRetry
);

Parâmetros

[in] hEntity

Manipule para a entidade de gerenciamento de destino de interesse.

[out] nPolicyRetry

Ponteiro para uma variável de inteiro longo sem sinal para receber o valor de contagem de repetições 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] nActualRetry

Ponteiro para uma variável de inteiro longo sem sinal para receber a última contagem de repetição real ou estimada 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
SNMPAPI_NOT_INITIALIZED	A função SnmpStartup não foi concluída com êxito.
SNMPAPI_ALLOC_ERROR	Ocorreu um erro durante a alocação de memória.
SNMPAPI_ENTITY_INVALID	O parâmetro hEntity é inválido.
SNMPAPI_NOOP	Os parâmetros nPolicyRetry e nActualRetry são NULL. A operação não foi executada.
SNMPAPI_OTHER_ERROR	Ocorreu um erro desconhecido ou indefinido.

Comentários

Normalmente, um aplicativo WinSNMP, em vez de um aplicativo de agente, chama a função SnmpGetRetry .

Um aplicativo WinSNMP pode modificar o valor da contagem de repetições com uma chamada para a função SnmpSetRetry .

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 da 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