Função SnmpStrToEntity (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 WinSNMP SnmpStrToEntity retorna um identificador para informações sobre uma entidade de gerenciamento SNMP específica para a implementação do Microsoft WinSNMP.

Sintaxe

HSNMP_ENTITY SNMPAPI_CALL SnmpStrToEntity(
  [in] HSNMP_SESSION session,
  [in] LPCSTR        string
);

Parâmetros

[in] session

Manipule para a sessão WinSNMP.

[in] string

Ponteiro para uma cadeia de caracteres terminada em nulo que identifica a entidade de gerenciamento SNMP de interesse. A configuração atual da entidade e do modo de tradução de contexto determina a maneira como SnmpStrToEntity interpreta a cadeia de caracteres de entrada da seguinte maneira.

Modo de Tradução de Entidade/Contexto	Significado
SNMPAPI_TRANSLATED	A implementação interpreta o parâmetro de cadeia de caracteres como um nome amigável. A implementação converte o nome em seus componentes SNMPv1 ou SNMPv2C usando o banco de dados da implementação.
SNMPAPI_UNTRANSLATED_V1	A implementação interpreta o parâmetro de cadeia de caracteres como um endereço de transporte SNMP literal.
SNMPAPI_UNTRANSLATED_V2	A implementação interpreta o parâmetro de cadeia de caracteres como um endereço de transporte SNMP literal.

Retornar valor

Se a função for bem-sucedida, o valor retornado será um identificador para a entidade de gerenciamento SNMP de interesse.

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_SESSION_INVALID	O parâmetro de sessão é inválido.
SNMPAPI_ENTITY_UNKNOWN	A cadeia de caracteres de entidade é inválida.
SNMPAPI_OTHER_ERROR	Ocorreu um erro desconhecido ou indefinido.

Comentários

A configuração atual da entidade e do modo de tradução de contexto determina a maneira como SnmpStrToEntity interpreta a cadeia de caracteres de entrada que identifica a entidade de gerenciamento de interesse. Para obter informações adicionais, consulte Suporte para cadeias de caracteres de endereço IPX no WinSNMP e Configurando o modo de conversão de entidade e contexto.

O aplicativo WinSNMP deve chamar a função SnmpFreeEntity para liberar o identificador de entidade alocado pela função SnmpStrToEntity . Para obter informações adicionais, consulte Conceitos de Gerenciamento de Dados WinSNMP.

A função SnmpStrToEntity retorna um identificador de entidade válido que um aplicativo WinSNMP pode usar como o parâmetro srcEntity ou dstEntity em várias funções WinSNMP. Essas funções incluem as funções SnmpSendMsg, SnmpRecvMsg, SnmpRegister, SnmpEncodeMsg e SnmpDecodeMsg .

A implementação retorna a entidade atual e o modo de tradução de contexto no parâmetro nTranslateMode da função SnmpStartup . Um aplicativo WinSNMP pode alterar a configuração da entidade e do modo de tradução de contexto com uma chamada para a função SnmpSetTranslateMode .

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