Função SnmpDeleteVb (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 SnmpDeleteVb remove uma entrada de associação de variável de uma lista de associações de variáveis.
Sintaxe
SNMPAPI_STATUS SNMPAPI_CALL SnmpDeleteVb(
[in] HSNMP_VBL vbl,
[in] smiUINT32 index
);
Parâmetros
[in] vbl
Manipule para a lista de associações de variáveis a ser atualizada.
[in] index
Especifica uma variável de inteiro longo sem sinal que identifica a entrada de associação de variável a ser removida. Essa variável contém a posição da entrada de associação de variável, dentro da lista de associações de variáveis.
Os valores válidos para esse parâmetro estão no intervalo de 1 a n, em que 1 indica a primeira entrada de associação de variável na lista de associações variáveis e n é o número total de entradas na lista de associações de variáveis. Para obter informações adicionais, consulte a seção Comentários a seguir.
Valor retornado
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. 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 index é inválido. |
|
O parâmetro vbl é inválido. |
|
Ocorreu um erro desconhecido ou indefinido. |
Comentários
Um aplicativo WinSNMP pode usar a função SnmpDeleteVb para excluir entradas de associação de variáveis inválidas. Quando uma PDU (unidade de dados de protocolo SNMP_PDU_RESPONSE ) inclui um erro que indica uma entrada de associação de variável inválida, o aplicativo pode chamar SnmpDeleteVb para excluir a entrada. Em seguida, o aplicativo pode reenviar a PDU de solicitação com uma chamada para a função SnmpSendMsg , sem a entrada de associação de variável inválida na lista de associações de variáveis. As PDUs de solicitação incluem os tipos de dados SNMP_PDU_GET, SNMP_PDU_GETNEXT e SNMP_PDU_GETBULK PDU.
Depois que a função SnmpDeleteVb excluir uma entrada de associação de variável, o valor de índice de todas as entradas após a entrada excluída diminuirá em um. Uma chamada para a função SnmpCountVbl retorna o novo número total de entradas na lista de associações de variáveis. O novo total é um a menos do que a contagem retornada por uma chamada para SnmpCountVbl antes da chamada atual para SnmpDeleteVb.
Se um aplicativo WinSNMP chamar a função SnmpDeleteVb e excluir a última entrada de associação de variável em uma lista de associações de variáveis, o resultado será uma lista de associações de variáveis vazia. A lista de associações de variáveis ainda tem um identificador válido e o aplicativo WinSNMP deve liberar o identificador com uma chamada para a função SnmpFreeVbl .
Veja a seguir os valores válidos a serem usados para o parâmetro de índice :
- O valor retornado de uma chamada para a função SnmpCountVbl
- O campo de índice de erro de uma PDU SNMP_PDU_RESPONSE retornada por uma chamada para a função SnmpRecvMsg
Requisitos
| 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 |