Função SnmpMgrCtl (mgmtapi.h)

Artigo
08/24/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 SnmpMgrCtl define um parâmetro operacional associado a uma sessão SNMP. Essa função é um elemento da API de Gerenciamento SNMP.

Sintaxe

BOOL SNMP_FUNC_TYPE SnmpMgrCtl(
  [in]  LPSNMP_MGR_SESSION session,
  [in]  DWORD              dwCtlCode,
  [in]  LPVOID             lpvInBuffer,
  [in]  DWORD              cbInBuffer,
  [out] LPVOID             lpvOUTBuffer,
  [out] DWORD              cbOUTBuffer,
  [out] LPDWORD            lpcbBytesReturned
);

Parâmetros

[in] session

Ponteiro para uma estrutura interna que especifica a sessão à qual o código de controle se aplica.

[in] dwCtlCode

Especifica um valor (um código de controle) que identifica a operação a ser executada.

Atualmente, MGMCTL_SETAGENTPORT é o único código de controle com suporte. Definir esse código permite que um aplicativo de gerenciamento SNMP envie solicitações para um agente remoto que está "escutando" solicitações do gerenciador SNMP em uma porta arbitrária. Para obter mais informações, consulte as descrições do parâmetro lpvInBuffer e cbInBuffer .

[in] lpvInBuffer

Ponteiro para o buffer que contém os parâmetros de entrada necessários para a operação.

Quando você especifica o código de controle MGMCTL_SETAGENTPORT, esse parâmetro deve apontar para um inteiro sem sinal que especifica o número da porta no qual o agente remoto "escutará" as solicitações do gerenciador SNMP. O número da porta deve estar em ordem de byte de host.

[in] cbInBuffer

Especifica o tamanho, em bytes, do buffer apontado pelo parâmetro lpvInBuffer .

Quando você especifica o código de controle MGMCTL_SETAGENTPORT, esse parâmetro é igual a sizeof (UINT).

[out] lpvOUTBuffer

Ponteiro para o buffer que recebe os dados de saída da operação.

[out] cbOUTBuffer

Especifica o tamanho, em bytes, do buffer apontado pelo parâmetro lpvOutBuffer .

[out] lpcbBytesReturned

Ponteiro para uma variável que recebe o tamanho real, em bytes, dos dados armazenados no buffer apontado pelo parâmetro lpvOutBuffer .

Valor retornado

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

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError. GetLastError também pode retornar um dos seguintes códigos de erro.

Código de retorno	Descrição
SNMP_MGMTAPI_INVALID_CTL	O parâmetro dwCtlCode não especifica um código de controle válido.
SNMP_MGMTAPI_INVALID_SESSION	O parâmetro de sessão não especifica uma sessão SNMP válida.
SNMP_MGMTAPI_INVALID_BUFFER	Um ou mais dos parâmetros lpvInBuffer, lpvOutBuffer ou lpcbBytesRequired são inválidos ou o parâmetro cbInBuffer ou cbOutBuffer é muito pequeno.

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	mgmtapi.h
Biblioteca	Mgmtapi.lib
DLL	Mgmtapi.dll

Confira também

Funções SNMP

Visão geral do Protocolo SNMP

SnmpMgrOpen

Compartilhar via