Função SnmpMgrOpen (mgmtapi.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 SnmpMgrOpen inicializa soquetes de comunicação e estruturas de dados, permitindo comunicações com o agente SNMP especificado. Essa função é um elemento da API de Gerenciamento SNMP.
Sintaxe
LPSNMP_MGR_SESSION SNMP_FUNC_TYPE SnmpMgrOpen(
[in] LPSTR lpAgentAddress,
[in] LPSTR lpAgentCommunity,
[in] INT nTimeOut,
[in] INT nRetries
);
Parâmetros
[in] lpAgentAddress
Ponteiro para uma cadeia de caracteres terminada em nulo que especifica um nome de host ou um endereço IP. O nome do host deve resolve para um endereço IP, um endereço IPX (na notação 8.12) ou um endereço ethernet. Consulte a seção Comentários para obter os formulários aceitáveis para nomes de host e endereços IP.
[in] lpAgentCommunity
Ponteiro para uma cadeia de caracteres terminada em nulo que especifica o nome da comunidade SNMP a ser usado ao se comunicar com o agente identificado pelo parâmetro lpAgentAddress .
[in] nTimeOut
Especifica o tempo limite de comunicações em milissegundos.
[in] nRetries
Especifica a contagem de repetições de comunicações. O tempo limite especificado no parâmetro nTimeOut é dobrado sempre que uma tentativa de repetição é transmitida.
Retornar valor
Se a função for bem-sucedida, o valor retornado será um ponteiro para uma estrutura LPSNMP_MGR_SESSION . Essa estrutura é usada internamente e o programador não deve alterá-la. Para obter mais informações, consulte a seção Comentários a seguir.
Se a função falhar, o valor retornado será NULL. Para obter informações de erro estendidas, chame GetLastError. GetLastError pode retornar o código de erro SNMP_MEM_ALLOC_ERROR, o que indica um erro de alocação de memória.
Essa função também pode retornar códigos de erro do Windows Sockets.
Comentários
Se possível, use um nome de host para identificar o agente SNMP no parâmetro lpAgentAddress . Os nomes de host só poderão ser fornecidos para agentes se TCP/IP for carregado e os nomes forem nomes de host TCP/IP. Os nomes NetBIOS não podem ser fornecidos para hosts IPX.
O nome e o endereço do destino SNMP, ou a cadeia de caracteres apontada pelo parâmetro lpAgentAddress , devem estar em conformidade com um dos formulários a seguir.
| Nome/Endereço | Formulário (exemplo) |
|---|---|
| Nome de host | merlin ou merlin.microsoft.com |
| Endereço IPv4 | 157.57.8.160 |
| Endereço IPv6 | 3ffe:8311:ffff::b3ff:fe88:c33 |
| Endereço MAC | 00aa00bbccdd |
| Endereço IPX | 00006112.00aa00bbccdd |
Os aplicativos não devem usar o ponteiro LPSNMP_MGR_SESSION retornado por essa função para chamar a função SnmpMgrRequest no contexto de um thread diferente.
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 | mgmtapi.h |
| Biblioteca | Mgmtapi.lib |
| DLL | Mgmtapi.dll |