Função SnmpStrToContext (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 SnmpStrToContext retorna um identificador para informações de contexto SNMP específicas para a implementação do Microsoft WinSNMP. O identificador é um valor válido que um aplicativo WinSNMP pode usar como o parâmetro de contexto em uma chamada para as funções SnmpSendMsg e SnmpRegister .

Sintaxe

HSNMP_CONTEXT SNMPAPI_CALL SnmpStrToContext(
  [in] HSNMP_SESSION session,
  [in] smiLPCOCTETS  string
);

Parâmetros

[in] session

Manipule para a sessão WinSNMP.

[in] string

Ponteiro para uma estrutura smiOCTETS que contém uma cadeia de caracteres a ser interpretada. A cadeia de caracteres pode identificar uma coleção de objetos gerenciados ou pode ser uma cadeia de caracteres da comunidade.

A configuração atual da entidade e do modo de tradução de contexto determina a maneira como SnmpStrToContext interpreta a estrutura da cadeia de caracteres de entrada, conforme mostrado na tabela a seguir.

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 para uma coleção de objetos gerenciados. 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 uma cadeia de caracteres literal da comunidade SNMP.
SNMPAPI_UNTRANSLATED_V2	A implementação interpreta o parâmetro de cadeia de caracteres como uma cadeia de caracteres literal da comunidade SNMP.

Valor retornado

Se a função for bem-sucedida, o valor retornado será um identificador para o contexto 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_CONTEXT_INVALID	O formato de parâmetro de cadeia de caracteres é inválido. Por exemplo, o membro len ou o membro ptr da estrutura smiOCTETS apontada pelo parâmetro string é NULL.
SNMPAPI_CONTEXT_UNKNOWN	O valor referenciado no parâmetro string não existe.
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 SnmpStrToContext interpreta a estrutura da cadeia de caracteres de entrada. Para obter informações adicionais, consulte Configurando o modo de tradução de entidade e contexto.

O aplicativo WinSNMP deve chamar a função SnmpFreeContext para liberar o identificador de contexto alocado pela função SnmpStrToContext . Para obter informações adicionais sobre como liberar recursos, consulte Conceitos de Gerenciamento de Dados do WinSNMP.

O aplicativo WinSNMP deve liberar a memória associada ao membro ptr da estrutura smiOCTETS apontada pelo parâmetro string . Isso ocorre porque o aplicativo define e aloca os recursos. Por exemplo, se o aplicativo alocar recursos com uma chamada para a função GlobalAlloc , ele deverá usar a função GlobalFree para desalocar os recursos. Para obter informações adicionais, consulte Freeing WinSNMP Descriptors.

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