Função SnmpOidToStr (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 SnmpOidToStr converte a representação binária interna de um identificador de objeto SNMP em seu formato de cadeia de caracteres numérica pontilhada, por exemplo, para "1.2.3.4.5.6".
Sintaxe
SNMPAPI_STATUS SNMPAPI_CALL SnmpOidToStr(
[in] smiLPCOID srcOID,
[in] smiUINT32 size,
[out] LPSTR string
);
Parâmetros
[in] srcOID
Ponteiro para uma estrutura smiOID com um identificador de objeto a ser convertido.
[in] size
Especifica o tamanho, em bytes, do buffer indicado pelo parâmetro de cadeia de caracteres . Para obter mais informações, consulte a seção Comentários a seguir.
[out] string
Ponteiro para um buffer para receber o identificador de objeto de cadeia de caracteres convertido que especifica a entidade de gerenciamento SNMP.
Valor retornado
Se a função for bem-sucedida, o valor retornado será o comprimento, em bytes, da cadeia de caracteres que o aplicativo WinSNMP grava no parâmetro de cadeia de caracteres. O valor retornado inclui um byte de terminação nula. Esse valor pode ser menor ou igual ao valor do parâmetro size , mas pode não ser maior.
Se a função falhar, o valor retornado será SNMPAPI_FAILURE. Para obter informações de erro estendidas, chame SnmpGetLastError especificando um valor NULL em seu parâmetro de sessão . 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 size é inválido. Esse parâmetro não pode ser igual a zero; ele deve indicar o tamanho do buffer apontado pelo parâmetro de cadeia de caracteres . |
|
O parâmetro srcOID é inválido. Para obter informações adicionais, consulte a seção Comentários a seguir. |
|
O comprimento do buffer de saída é insuficiente. |
|
Ocorreu um erro desconhecido ou indefinido. |
Comentários
É recomendável que um aplicativo WinSNMP especifique, com o parâmetro size , um buffer de cadeia de caracteres de comprimento MAXOBJIDSTRSIZE (1408 bytes). Isso garante que o buffer de saída seja grande o suficiente para manter a cadeia de caracteres convertida. Como a cadeia de caracteres convertida geralmente é menor que MAXOBJIDSTRSIZE, o aplicativo WinSNMP pode copiar a cadeia de caracteres convertida para um buffer menor. Em seguida, o aplicativo pode reutilizar ou liberar a memória alocada para o buffer inicial. Para obter informações adicionais, consulte Conceitos de Gerenciamento de Dados WinSNMP.
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 |