Função SnmpSetVb (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 SnmpSetVb do WinSNMP altera as entradas de associação de variáveis em uma lista de associações de variáveis. Essa função também acrescenta novas entradas de associação de variável a uma lista de associações de variáveis existente.

Sintaxe

SNMPAPI_STATUS SNMPAPI_CALL SnmpSetVb(
  [in] HSNMP_VBL   vbl,
  [in] smiUINT32   index,
  [in] smiLPCOID   name,
  [in] smiLPCVALUE value
);

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 contém a posição da entrada de associação de variável, dentro da lista de associações de variáveis, se esta for uma operação de atualização. Se essa for uma operação de acréscimo, esse parâmetro deverá ser igual a zero. Para obter mais informações, consulte a seção Comentários a seguir.

[in] name

Ponteiro para uma estrutura smiOID que representa o nome da variável a ser acrescentada ou alterada. Para obter mais informações, consulte a seção Comentários a seguir.

[in] value

Ponteiro para uma estrutura smiVALUE . A estrutura contém o valor associado à variável especificada pelo parâmetro name .

Valor retornado

Se a função for bem-sucedida, o valor retornado será a posição da entrada de associação de variável atualizada ou acrescentada na lista de associações de variáveis. Para obter informações adicionais, consulte a seção Comentários a seguir.

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
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_VBL_INVALID	O parâmetro vbl é inválido.
SNMPAPI_INDEX_INVALID	O parâmetro index é inválido.
SNMPAPI_OID_INVALID	O parâmetro name é inválido.
SNMPAPI_SYNTAX_INVALID	O membro de sintaxe da estrutura apontada pelo parâmetro value é inválido.
SNMPAPI_OTHER_ERROR	Ocorreu um erro desconhecido ou indefinido.

Comentários

Os valores válidos para o parâmetro de índice variam de zero a n. O valor zero indica uma operação de acréscimo. O valor n é o número total de entradas de associação de variáveis na lista de associações de variáveis. Um aplicativo WinSNMP deve chamar a função SnmpCountVbl antes de chamar SnmpSetVb para obter o número total de entradas de associação variável.

Se a função executar com êxito uma operação de atualização, o valor retornado será igual ao valor do parâmetro index . Se a função acrescentar uma entrada de associação de variável, o valor retornado será n + 1.

Se o parâmetro name não for NULL, mas o parâmetro value for NULL, a implementação do Microsoft WinSNMP inicializará a nova entrada de associação de variável com o membro de valor definido como NULL e com o membro de sintaxe definido como SNMP_SYNTAX_.

Se o parâmetro de índice não for igual a zero e o parâmetro name for NULL, a implementação do Microsoft WinSNMP atualizará apenas o valor da variável apontada pelo parâmetro index .

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