Função SnmpContextToStr (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 SnmpContextToStr retorna uma cadeia de caracteres que identifica um contexto SNMP, que é um conjunto de recursos de objeto gerenciado. A função retorna a cadeia de caracteres em uma estrutura smiOCTETS .
Sintaxe
SNMPAPI_STATUS SNMPAPI_CALL SnmpContextToStr(
[in] HSNMP_CONTEXT context,
[out] smiLPOCTETS string
);
Parâmetros
[in] context
Manipule para o contexto de interesse do SNMP.
[out] string
Ponteiro para uma estrutura smiOCTETS para receber a cadeia de caracteres que identifica o contexto de interesse. A cadeia de caracteres pode ter um byte de terminação nula.
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 de contexto é inválido. |
|
Ocorreu um erro desconhecido ou indefinido. |
Comentários
A configuração atual da entidade e do modo de tradução de contexto determina o tipo de cadeia de caracteres de saída que SnmpContextToStr retorna. Para obter informações adicionais, consulte Configurando o modo de tradução de entidade e contexto.
O aplicativo WinSNMP deve fornecer o endereço de uma estrutura smiOCTETS válida para o parâmetro de cadeia de caracteres . Se a função SnmpContextToStr for concluída com êxito, a implementação do Microsoft WinSNMP inicializará os membros len e ptr da estrutura. O aplicativo WinSNMP deve chamar a função SnmpFreeDescriptor para habilitar a implementação para liberar os recursos para esses membros.
Quando a entidade e o modo de tradução de contexto são SNMPAPI_TRANSLATED e a entrada existe no banco de dados da implementação, a implementação retorna o nome amigável do contexto associado. Se uma entrada não existir para o nome de contexto, SnmpContextToStr retornará a cadeia de caracteres da comunidade SNMP.
Quando a entidade e o modo de tradução de contexto são SNMPAPI_UNTRANSLATED_V1 ou SNMPAPI_UNTRANSLATED_V2, a implementação também retorna a cadeia de caracteres da comunidade SNMP.
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 |