Função SnmpExtensionInit (snmp.h)

Artigo
03/05/2024

[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.]

O serviço Microsoft SNMP chama a função SnmpExtensionInit para inicializar a DLL do agente de extensão SNMP. Essa função é um elemento da API do Agente de Extensão SNMP.

Sintaxe

BOOL SNMP_FUNC_TYPE SnmpExtensionInit(
  [in]  DWORD               dwUptimeReference,
  [out] HANDLE              *phSubagentTrapEvent,
  [out] AsnObjectIdentifier *pFirstSupportedRegion
);

Parâmetros

[in] dwUptimeReference

Especifica uma referência de tempo zero para o agente de extensão.

Nota Os agentes de extensão devem ignorar esse parâmetro. A DLL do agente de extensão SNMP deve usar a função SnmpSvcGetUptime para recuperar o número de centisegundos que o serviço SNMP está executando. Para obter mais informações, consulte a seção Comentários a seguir.

[out] phSubagentTrapEvent

Ponteiro para um identificador de evento que o agente de extensão passa de volta para o serviço SNMP. Esse identificador é usado para notificar o serviço de que o agente de extensão tem uma ou mais armadilhas a serem enviadas. Para obter informações adicionais sobre como alocar e desalocar o identificador de eventos, consulte a seção Comentários a seguir.

[out] pFirstSupportedRegion

Ponteiro para uma estrutura AsnObjectIdentifier para receber a primeira subárvore MIB compatível com o agente de extensão. Para obter informações adicionais sobre como alocar e desalocar recursos para essa estrutura, consulte a seção Comentários a seguir.

O agente de extensão pode registrar subárvores MIB adicionais implementando a função de ponto de entrada SnmpExtensionInitEx .

Retornar valor

Se a função for bem-sucedida, o valor retornado será TRUE.

Se a função falhar, o valor retornado será FALSE.

Comentários

Os agentes de extensão devem ignorar o parâmetro dwUptimeReference . Em vez disso, eles devem chamar a função SnmpSvcGetUptime para recuperar o número de centisegundos que o serviço SNMP da Microsoft está executando. Como o parâmetro dwUptimeReference armazena o tempo decorrido como um valor DWORD em milissegundos, o tempo pode ser encapsulado como zero e refletir um intervalo de tempo impreciso.

O agente de extensão notifica o serviço SNMP de que ele precisa enviar uma ou mais armadilhas definindo o identificador de evento passado de volta no parâmetro phSubagentTrapEvent para o estado sinalizado. Depois que esse evento tiver sido sinalizado, o serviço SNMP chamará repetidamente o ponto de entrada SnmpExtensionTrap do agente de extensão até que a função retorne um valor false. Isso indica que o agente de extensão não tem mais armadilhas a serem enviadas. Se o agente de extensão não gerar armadilhas, o parâmetro phSubagentTrapEvent deverá retornar um valor NULL.

O agente de extensão SNMP deve alocar e desalocar recursos para o identificador de evento trap. Quando o serviço SNMP chama a função SnmpExtensionInit , o agente de extensão deve chamar a função CreateEvent para alocar o identificador de evento. O agente de extensão passa o identificador para o serviço SNMP no parâmetro phSubagentTrapEvent . Quando o serviço SNMP chama a função SnmpExtensionClose , o agente de extensão deve desalocar recursos para o identificador de evento trap.

O serviço SNMP faz uma cópia da estrutura AsnObjectIdentifier que o agente de extensão retorna no parâmetro pFirstSupportedRegion . O agente de extensão deve alocar e desalocar os recursos associados à estrutura original. Ele pode fazer isso quando o serviço SNMP chama a função SnmpExtensionClose .

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	snmp.h