Função SnmpEntityToStr (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 SnmpEntityToStr retorna uma cadeia de caracteres que identifica uma entidade de gerenciamento SNMP.
Sintaxe
SNMPAPI_STATUS SNMPAPI_CALL SnmpEntityToStr(
[in] HSNMP_ENTITY entity,
[in] smiUINT32 size,
[out] LPSTR string
);
Parâmetros
[in] entity
Manipule para a entidade de gerenciamento SNMP de interesse.
[in] size
Especifica o tamanho, em bytes, do buffer apontado pelo parâmetro de cadeia de caracteres . O aplicativo WinSNMP deve alocar um buffer grande o suficiente para conter a cadeia de caracteres de saída.
[out] string
Ponteiro para um buffer para receber a cadeia de caracteres terminada em nulo que identifica a entidade de gerenciamento SNMP de interesse.
Retornar valor
Se a função for bem-sucedida, o valor retornado será o número de bytes, incluindo um byte nulo de terminação, que SnmpEntityToStr retorna no buffer de cadeia de caracteres . Esse valor pode ser menor ou igual ao valor do parâmetro size , mas não pode ser maior.
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 entidade é inválido. |
|
O comprimento do buffer de saída é insuficiente. |
|
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 SnmpEntityToStr retorna. 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.
Quando o modo de conversão de entidade e contexto é SNMPAPI_TRANSLATED e existe uma entrada no banco de dados da implementação, a implementação retorna o nome amigável associado da entidade de gerenciamento. Se uma entrada não existir para a entidade de gerenciamento, SnmpEntityToStr retornará o endereço de transporte SNMP literal da entidade de gerenciamento.
Quando o modo de conversão de entidade e contexto é SNMPAPI_UNTRANSLATED_V1 ou SNMPAPI_UNTRANSLATED_V2, a implementação do Microsoft WinSNMP também retorna o endereço de transporte SNMP literal da entidade de gerenciamento.
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 |