Função SnmpStartup (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 SnmpStartup notifica a implementação do Microsoft WinSNMP de que o aplicativo WinSNMP requer os serviços da implementação. A função WinSNMP SnmpStartup permite que a implementação inicialize e retorne ao aplicativo a versão da API WinSNMP (Interface de Programação de Aplicativo SNMP do Windows), o nível de comunicações SNMP compatíveis com a implementação e os modos de conversão e retransmissão padrão da implementação.
Sintaxe
SNMPAPI_STATUS SNMPAPI_CALL SnmpStartup(
[out] smiLPUINT32 nMajorVersion,
[out] smiLPUINT32 nMinorVersion,
[out] smiLPUINT32 nLevel,
[out] smiLPUINT32 nTranslateMode,
[out] smiLPUINT32 nRetransmitMode
);
Parâmetros
[out] nMajorVersion
Ponteiro para uma variável de inteiro longo sem sinal para receber o número de versão principal da API WinSNMP compatível com a implementação. Por exemplo, para indicar que a implementação dá suporte ao WinSNMP versão 2.0, a função retorna um valor de 2.
[out] nMinorVersion
Ponteiro para uma variável de inteiro longo sem sinal para receber o número de versão secundária da API WinSNMP compatível com a implementação. Por exemplo, para indicar que a implementação dá suporte ao WinSNMP versão 2.0, a função retorna um valor de 0.
[out] nLevel
Ponteiro para uma variável de inteiro longo sem sinal para receber o nível mais alto de comunicações SNMP compatíveis com a implementação. Após o retorno bem-sucedido, esse parâmetro contém um valor de 2. Para obter uma descrição do suporte de nível 2, consulte Níveis de suporte SNMP.
[out] nTranslateMode
Ponteiro para uma variável de inteiro longo sem sinal para receber o modo de tradução padrão em vigor para a implementação. O modo de tradução aplica-se à interpretação da implementação do parâmetro de entidade que o aplicativo WinSNMP passa para a função SnmpStrToEntity . O modo de tradução também se aplica ao parâmetro de cadeia de caracteres que o aplicativo WinSNMP passa para a função SnmpStrToContext . Esse parâmetro pode usar um dos valores a seguir.
Para obter informações adicionais, consulte Configurando o modo de conversão de entidade e contexto.
[out] nRetransmitMode
Ponteiro para uma variável de inteiro longo sem sinal para receber o modo de retransmissão padrão em vigor para a implementação. Esse parâmetro pode usar um dos valores a seguir.
Para obter informações adicionais, consulte Sobre a retransmissão.
Retornar valor
Se a função for bem-sucedida, o valor retornado será SNMPAPI_SUCCESS e os parâmetros conterão valores apropriados, conforme indicado nas descrições de parâmetro anteriores.
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. Para obter informações adicionais, consulte a seção Comentários 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. |
|
Ocorreu um erro desconhecido ou indefinido. |
Comentários
Um aplicativo WinSNMP deve chamar a função SnmpStartup com êxito pelo menos uma vez, antes de chamar qualquer outra função WinSNMP. Se um aplicativo WinSNMP chamar outra função WinSNMP, antes de chamar SnmpStartup com êxito, a implementação retornará o erro SNMPAPI_NOT_INITIALIZED.
O aplicativo WinSNMP pode chamar SnmpGetLastError para obter informações de erro ou tentar novamente SnmpStartup se uma chamada para a função SnmpStartup falhar. Quando SnmpStartup retorna SNMPAPI_FAILURE e uma chamada subsequente para SnmpGetLastError retorna SNMP_ALLOC_ERROR, o aplicativo WinSNMP pode optar por aguardar. Ele pode repetir a chamada para SnmpStartup quando a implementação tiver recursos livres adequados.
Um aplicativo WinSNMP pode chamar SnmpStartup várias vezes. Por exemplo, talvez seja necessário repetir a chamada de função pelos motivos discutidos anteriormente. Um aplicativo WinSNMP também deve chamar SnmpCleanup pelo menos uma vez, como a última chamada de função WinSNMP antes de terminar. Várias chamadas SnmpStartup não exigem várias chamadas SnmpCleanup .
Para obter informações adicionais, consulte Níveis de suporte de SNMP e Sobre versões SNMP.
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 |